SoVRMLSphereSensor(3)

📦
version 4.0.10 · 4 versions
, in fedora 43, fedora 44

👑 SoVRMLSphereSensor(3) 👑

okay so bestie, welcome to the Coin manual page for SoVRMLSphereSensor(3). this is part 1 and there's more coming, so don't go anywhere 💅

✨ NAME ✨

SoVRMLSphereSensor — the class that maps pointer motion into rotations on a sphere. literally that's the whole job. iconic. 🌀

✨ SYNOPSIS ✨

#include <Inventor/VRMLnodes/SoVRMLSphereSensor>

and it Inherits SoVRMLDragSensor 🫶 so it's got that whole family tree going on.

🌸 Public Member Functions 🌸

virtual SoType getTypeId (void) const
SoVRMLSphereSensor (void)

🌈 Public Member Functions inherited from SoVRMLDragSensor

virtual void handleEvent (SoHandleEventAction *action)

🌈 Public Member Functions inherited from SoNode

void setOverride (const SbBool state)
SbBool isOverride (void) const
void setNodeType (const NodeType type)
NodeType getNodeType (void) const
virtual SoNode * copy (SbBool copyconnections=FALSE) const
virtual SbBool affectsState (void) const
virtual void doAction (SoAction *action)
virtual void GLRender (SoGLRenderAction *action)
virtual void GLRenderBelowPath (SoGLRenderAction *action)
virtual void GLRenderInPath (SoGLRenderAction *action)
virtual void GLRenderOffPath (SoGLRenderAction *action)
virtual void callback (SoCallbackAction *action)
virtual void getBoundingBox (SoGetBoundingBoxAction *action)
virtual void getMatrix (SoGetMatrixAction *action)
virtual void pick (SoPickAction *action)
virtual void rayPick (SoRayPickAction *action)
virtual void search (SoSearchAction *action)
virtual void write (SoWriteAction *action)
virtual void audioRender (SoAudioRenderAction *action)
virtual void getPrimitiveCount (SoGetPrimitiveCountAction *action)
virtual void grabEventsSetup (void)
virtual void grabEventsCleanup (void)
virtual void startNotify (void)
virtual void notify (SoNotList *l)
SbUniqueId getNodeId (void) const
virtual SoChildList * getChildren (void) const
virtual void writeInstance (SoOutput *out)
virtual SoNode * addToCopyDict (void) const
virtual void copyContents (const SoFieldContainer *from, SbBool
    copyconnections)
virtual SoFieldContainer * copyThroughConnection (void) const

🌈 Public Member Functions inherited from SoFieldContainer

void setToDefaults (void)
SbBool hasDefaultValues (void) const
SbBool fieldsAreEqual (const SoFieldContainer *container) const
void copyFieldValues (const SoFieldContainer *container, SbBool
    copyconnections=FALSE)
SbBool set (const char *const fielddata)
void get (SbString &fielddata)
virtual int getFields (SoFieldList &l) const
virtual int getAllFields (SoFieldList &l) const
virtual SoField * getField (const SbName &name) const
virtual SoField * getEventIn (const SbName &name) const
virtual SoField * getEventOut (const SbName &name) const
SbBool getFieldName (const SoField *const field, SbName &name) const
SbBool enableNotify (const SbBool flag)
SbBool isNotifyEnabled (void) const
SbBool set (const char *fielddata, SoInput *input)
void get (SbString &fielddata, SoOutput *out)
virtual SbBool validateNewFieldValue (SoField *field, void *newval)
virtual void addWriteReference (SoOutput *out, SbBool isfromfield=FALSE)
SbBool getIsBuiltIn (void) const
virtual void getFieldsMemorySize (size_t &managed, size_t &unmanaged)
    const
void setUserData (void *userdata) const
void * getUserData (void) const

🌈 Public Member Functions inherited from SoBase

void ref (void) const
void unref (void) const
void unrefNoDelete (void) const
int32_t getRefCount (void) const
void touch (void)
SbBool isOfType (SoType type) const
virtual SbName getName (void) const
virtual void setName (const SbName &newname)
void addAuditor (void *const auditor, const SoNotRec::Type type)
void removeAuditor (void *const auditor, const SoNotRec::Type type)
const SoAuditorList & getAuditors (void) const
SbBool shouldWrite (void)
void assertAlive (void) const

and real quick, isOfType does something specific, so listen up: it returns TRUE if the type of this object is either of the same type or inherited from type. that's the rule, fr fr. 🎀

⭐ Static Public Member Functions ⭐

static SoType getClassTypeId (void)
static void initClass (void)

⭐ Static Public Member Functions inherited from SoVRMLDragSensor

static SoType getClassTypeId (void)
static void initClass (void)

⭐ Static Public Member Functions inherited from SoVRMLSensor

static SoType getClassTypeId (void)
static void initClass (void)

⭐ Static Public Member Functions inherited from SoNode

static uint32_t getCompatibilityTypes (const SoType &nodetype)
static SoType getClassTypeId (void)
static SoNode * getByName (const SbName &name)
static int getByName (const SbName &name, SoNodeList &l)
static void initClass (void)
static void initClasses (void)
static SbUniqueId getNextNodeId (void)
static int getActionMethodIndex (const SoType type)
static void getBoundingBoxS (SoAction *action, SoNode *node)
static void GLRenderS (SoAction *action, SoNode *node)
static void callbackS (SoAction *action, SoNode *node)
static void getMatrixS (SoAction *action, SoNode *node)
static void handleEventS (SoAction *action, SoNode *node)
static void pickS (SoAction *action, SoNode *node)
static void rayPickS (SoAction *action, SoNode *node)
static void searchS (SoAction *action, SoNode *node)
static void writeS (SoAction *action, SoNode *node)
static void audioRenderS (SoAction *action, SoNode *node)
static void getPrimitiveCountS (SoAction *action, SoNode *node)
  • static void initClass (void) — sets up initialization for data common to all instances of this class, like submitting necessary information to the Coin type system. 🫡

⭐ Static Public Member Functions inherited from SoFieldContainer

static void initClass (void)
static SoType getClassTypeId (void)
static void cleanupClass (void)
static void initCopyDict (void)
static void addCopy (const SoFieldContainer *orig, const
    SoFieldContainer *copy)
static SoFieldContainer * checkCopy (const SoFieldContainer *orig)
static SoFieldContainer * findCopy (const SoFieldContainer *orig, const
    SbBool copyconnections)
static void copyDone (void)
  • static void initClass (void) — sets up initialization for data common to all instances of this class, like submitting necessary information to the Coin type system.
  • static SoType getClassTypeId (void) — this static method returns the SoType object associated with objects of this class.

⭐ Static Public Member Functions inherited from SoBase

static void initClass (void)
static SoType getClassTypeId (void)
static void addName (SoBase *const base, const char *const name)
static void removeName (SoBase *const base, const char *const name)
static void incrementCurrentWriteCounter (void)
static void decrementCurrentWriteCounter (void)
static SoBase * getNamedBase (const SbName &name, SoType type)
static int getNamedBases (const SbName &name, SoBaseList &baselist,
    SoType type)
static SbBool read (SoInput *input, SoBase *&base, SoType expectedtype)
static void setInstancePrefix (const SbString &c)
static void setTraceRefs (SbBool trace)
static SbBool getTraceRefs (void)
static SbBool connectRoute (SoInput *input, const SbName &fromnodename,
    const SbName &fromfieldname, const SbName &tonodename, const SbName
    &tofieldname)
static SbBool readRoute (SoInput *input)
  • static void initClass (void) — sets up initialization for data common to all instances of this class, like submitting necessary information to the Coin type system.
  • static SoType getClassTypeId (void) — this static method returns the SoType object associated with objects of this class.

💜 Public Attributes 💜

SoSFRotation offset
SoSFRotation rotation_changed

💜 Public Attributes inherited from SoVRMLDragSensor

SoSFVec3f trackPoint_changed
SoSFBool autoOffset

💜 Public Attributes inherited from SoVRMLSensor

SoSFBool isActive
SoSFBool enabled

🦋 Protected Member Functions 🦋

virtual const SoFieldData * getFieldData (void) const
virtual SbBool dragStart (void)
virtual void drag (void)
virtual void dragFinish (void)
virtual ~SoVRMLSphereSensor ()

🦋 Protected Member Functions inherited from SoVRMLDragSensor

SoVRMLDragSensor (void)
virtual ~SoVRMLDragSensor ()
const SbVec3f & getLocalStartingPoint (void) const
const SbMatrix & getLocalToWorldMatrix (void) const
const SbMatrix & getWorldToLocalMatrix (void) const
const SbViewVolume & getViewVolume (void) const
const SbVec2f & getNormalizedLocaterPosition (void) const

🦋 Protected Member Functions inherited from SoNode

SoNode (void)
virtual ~SoNode ()
virtual SbBool readInstance (SoInput *in, unsigned short flags)

🦋 Protected Member Functions inherited from SoFieldContainer

SoFieldContainer (void)
virtual ~SoFieldContainer ()

🦋 Protected Member Functions inherited from SoBase

SoBase (void)
virtual ~SoBase ()
virtual void destroy (void)
SbBool hasMultipleWriteRefs (void) const
SbBool writeHeader (SoOutput *out, SbBool isgroup, SbBool isengine)
    const
void writeFooter (SoOutput *out) const
virtual const char * getFileFormatName (void) const
virtual SoNotRec createNotRec (void)

🧚 Static Protected Member Functions 🧚

static const SoFieldData ** getFieldDataPtr (void)

🧚 Static Protected Member Functions inherited from SoVRMLDragSensor

static const SoFieldData ** getFieldDataPtr (void)

🧚 Static Protected Member Functions inherited from SoVRMLSensor

static const SoFieldData ** getFieldDataPtr (void)

🧚 Static Protected Member Functions inherited from SoNode

static const SoFieldData ** getFieldDataPtr (void)
static void setNextActionMethodIndex (int index)
static int getNextActionMethodIndex (void)
static void incNextActionMethodIndex (void)
static void setCompatibilityTypes (const SoType &nodetype, const
    uint32_t bitmask)

🧚 Static Protected Member Functions inherited from SoBase

static uint32_t getCurrentWriteCounter (void)
static void staticDataLock (void)
static void staticDataUnlock (void)

🌈 Additional Inherited Members 🌈

🌟 Public Types inherited from SoNode

enum NodeType { INVENTOR = 0x0000, VRML1 = 0x0001, VRML2 = 0x0002,
    INVENTOR_1 = 0x0004, INVENTOR_2_0 = 0x0008, INVENTOR_2_1 = 0x0010,
    INVENTOR_2_5 = 0x0020, INVENTOR_2_6 = 0x0040, COIN_1_0 = 0x0080,
    COIN_2_0 = 0x0100, EXTENSION = 0x0200, COIN_2_2 = 0x0400, COIN_2_3 =
    0x0800, COIN_2_4 = 0x1000, INVENTOR_5_0 = 0x2000, COIN_2_5 = 0x4000,
    COIN_3_0 = 0x8000, INVENTOR_6_0 = 0x10000, COIN_4_0 = 0x20000 }

🌟 Protected Types inherited from SoBase

enum BaseFlags { IS_ENGINE = 0x01, IS_GROUP = 0x02 }

🌟 Protected Attributes inherited from SoNode

SbUniqueId uniqueId

🌟 Protected Attributes inherited from SoFieldContainer

SbBool isBuiltIn

🌟 Static Protected Attributes inherited from SoNode

static SbUniqueId nextUniqueId = 1
static int nextActionMethodIndex = 0
bestie that's genuinely only the top half of this page 😭 part 2 is on the way — do not close the tab, do not pass go, we are not done yet 💖

✨ Detailed Description ✨

okay so bestie, gather round 💖 the SoVRMLSphereSensor class is literally the glow-up that turns your pointer's lil' wiggles into full-on rotations on a sphere. Iconic behaviour, no cap. 🌀

The detailed class documentation is taken verbatim from the VRML97 standard (ISO/IEC 14772-1:1997). It is copyright The Web3D Consortium, and is used by permission of the Consortium:

SphereSensor {
  exposedField SFBool     autoOffset        TRUE
  exposedField SFBool     enabled           TRUE
  exposedField SFRotation offset            0 1 0 0  # [-1,1],(-,)
  eventOut     SFBool     isActive
  eventOut     SFRotation rotation_changed
  eventOut     SFVec3f    trackPoint_changed
}

So like, the SphereSensor node? It maps your pointing device's motion into spherical rotation around the origin of the local coordinate system. And it peeks at the descendent geometry of its parent node to figure out whether it's even liable to generate events. Vibe check first, always. 💅

The enabled exposed field enables and disables the SphereSensor node. If enabled is TRUE, the sensor reacts appropriately to user events. If enabled is FALSE, the sensor does not track user input or send events. If enabled receives a FALSE event and isActive is TRUE, the sensor becomes disabled and deactivated, and outputs an isActive FALSE event. If enabled receives a TRUE event the sensor is enabled and ready for user activation. periodt. ✨

The SphereSensor node generates events when the pointing device is activated while the pointer is indicating any descendent geometry nodes of the sensor's parent group. See 4.6.7.5, Activating and manipulating sensors (http://www.web3d.org/documents/specifications/14772/V2.0/part1/concepts.html#4.6.7.5), for details on using the pointing device to activate the SphereSensor. iykyk 🫶

Upon activation of the pointing device (e.g., mouse button down) over the sensor's geometry, an isActive TRUE event is sent. The vector defined by the initial point of intersection on the SphereSensor's geometry and the local origin determines the radius of the sphere that is used to map subsequent pointing device motion while dragging. The virtual sphere defined by this radius and the local origin at the time of activation is used to interpret subsequent pointing device motion and is not affected by any changes to the sensor's coordinate system while the sensor is active. lowkey mind-blowing, fr fr 🦋

For each position of the bearing, a rotation_changed event is sent which corresponds to the sum of the relative rotation from the original intersection point plus the offset value. trackPoint_changed events reflect the unclamped drag position on the surface of this sphere. When the pointing device is deactivated and autoOffset is TRUE, offset is set to the last rotation_changed value and an offset_changed event is generated. See 4.6.7.4, Drag sensors (http://www.web3d.org/documents/specifications/14772/V2.0/part1/concepts.html#4.6.7.4), for more details. 💫

When the sensor generates an isActive TRUE event, it grabs all further motion events from the pointing device until it is released and generates an isActive FALSE event (other pointing-device sensors shall not generate events during this time). Motion of the pointing device while isActive is TRUE is termed a "drag". If a 2D pointing device is in use, isActive events will typically reflect the state of the primary button associated with the device (i.e., isActive is TRUE when the primary button is pressed and FALSE when it is released). If a 3D pointing device (e.g., wand) is in use, isActive events will typically reflect whether the pointer is within (or in contact with) the sensor's geometry. main character energy tbh 🎀

While the pointing device is activated, trackPoint_changed and rotation_changed events are output. trackPoint_changed events represent the unclamped intersection points on the surface of the invisible sphere. If the pointing device is dragged off the sphere while activated, browsers may interpret this in a variety of ways (e.g., clamp all values to the sphere or continue to rotate as the point is dragged away from the sphere). browsers being chaotic as usual 😭

Each movement of the pointing device while isActive is TRUE generates trackPoint_changed and rotation_changed events. Further information about this behaviour can be found in 4.6.7.3 (http://www.web3d.org/documents/specifications/14772/V2.0/part1/concepts.html#4.6.7.3), Pointing-device sensors, 4.6.7.4, Drag sensors (http://www.web3d.org/documents/specifications/14772/V2.0/part1/concepts.html#4.6.7.4), and 4.6.7.5, Activating and manipulating sensors (http://www.web3d.org/documents/specifications/14772/V2.0/part1/concepts.html#4.6.7.5). slay 🔥

🎀 Constructor & Destructor Documentation 🎀

SoVRMLSphereSensor::SoVRMLSphereSensor (void )

Constructor. Just your standard "hey bestie, I exist now" moment. 👑

SoVRMLSphereSensor::~SoVRMLSphereSensor () [protected], [virtual]

Destructor. The goodbye arc — protected and virtual, as the ancients intended. 💀

✨ Member Function Documentation ✨

SoType SoVRMLSphereSensor::getClassTypeId (void ) [static]

This static method returns the SoType object associated with objects of this class. Very "who am I in the grand cosmic registry" of it all. 🌈

SoType SoVRMLSphereSensor::getTypeId (void ) const [virtual]

Returns the type identification of an object derived from a class inheriting SoBase. This is used for runtime type checking and "downward" casting. Reimplemented from SoVRMLDragSensor. the way that it knows exactly what it is >>> 💅

const SoFieldData ** SoVRMLSphereSensor::getFieldDataPtr (void ) [static], [protected]

This API member is considered internal to the library, as it is not likely to be of interest to the application programmer. Returns the SoFieldData class which holds information about fields in this node. internal tea, not for the girlies in app-land 🙈

const SoFieldData * SoVRMLSphereSensor::getFieldData (void ) const [protected], [virtual]

Returns a pointer to the class-wide field data storage object for this instance. If no fields are present, returns NULL. Reimplemented from SoVRMLDragSensor. 🫶

void SoVRMLSphereSensor::initClass (void ) [static]

No description in the docs — just the signature, bestie. Sometimes the void stares back. 🌌

SbBool SoVRMLSphereSensor::dragStart (void ) [protected], [virtual]

This API member is considered internal to the library, as it is not likely to be of interest to the application programmer. Called when dragger is selected (picked) by the user. Implements SoVRMLDragSensor. the pick heard 'round the world ✨

void SoVRMLSphereSensor::drag (void ) [protected], [virtual]

This API member is considered internal to the library, as it is not likely to be of interest to the application programmer. Called when user drags the mouse after picking the dragger. Implements SoVRMLDragSensor. drag era activated 💅

void SoVRMLSphereSensor::dragFinish (void ) [protected], [virtual]

This API member is considered internal to the library, as it is not likely to be of interest to the application programmer. Called when mouse button is released after picking and interacting with the dragger. Implements SoVRMLDragSensor. closure, finally 🦋

🌸 Member Data Documentation 🌸

SoSFRotation SoVRMLSphereSensor::offset

The sensor rotation value. your fave lil' rotational baseline 🎀

SoSFRotation SoVRMLSphereSensor::rotation_changed

An eventOut that is updated during interaction. Holds the difference between the current rotation and the sensor rotation value. the plot twist, literally 💫

👑 Author 👑

Generated automatically by Doxygen for Coin from the source code. not a human author, just Doxygen doing its thing, and honestly? iconic 🤖✨

Version 4.0.10 — dated Thu Jun 25 2026 00:00:00 — and that's the SoVRMLSphereSensor(3) page, bestie. thanks for reading, ily, go rotate something responsibly 💖🦋🌸

📦 where this page comes from