SoVRMLSphereSensor(3)

📦 version 3.1.3, in fedora 43, fedora 44

💖 SoVRMLSphereSensor 💖

okay bestie, welcome to SoVRMLSphereSensor(3) — the manual page, from the Library Functions Manual, but make it cute. This is part 1 of 2, so buckle up 🎀

✨ NAME ✨

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

🌸 SYNOPSIS 🌸

#include <Inheritor/VRMLnodes/SoVRMLSphereSensor>

wait, sorry, typo brain — it's literally:

#include <Inventor/VRMLnodes/SoVRMLSphereSensor>

Inherits SoVRMLDragSensor. it's giving "part of the family tree, and it knows it" 👑

🫶 Public Member Functions

  • virtual SoType getTypeId (void) const — hands you back the type id of this thing. the ✨identity✨ check.
  • SoVRMLSphereSensor (void) — the constructor. makes a brand new sphere sensor. hi bb 🎀

Public Member Functions inherited from SoVRMLDragSensor

  • virtual void handleEvent (SoHandleEventAction *action) — deals with the incoming event action. the drama handler 💅

Public Member Functions inherited from SoNode

  • void setOverride (const SbBool state) — sets the override state.
  • SbBool isOverride (void) const — tells you if it's overriding or not.
  • void setNodeType (const NodeType type) — sets the node type.
  • NodeType getNodeType (void) const — gets the node type back.
  • virtual SoNode * copy (SbBool copyconnections=FALSE) const — copies the node. copyconnections defaults to FALSE.
  • virtual SbBool affectsState (void) const — does this node mess with the state? inquiring minds.
  • virtual void doAction (SoAction *action) — runs the action, generic style.
  • virtual void GLRender (SoGLRenderAction *action) — renders it with OpenGL.
  • virtual void GLRenderBelowPath (SoGLRenderAction *action) — renders below the path.
  • virtual void GLRenderInPath (SoGLRenderAction *action) — renders in the path.
  • virtual void GLRenderOffPath (SoGLRenderAction *action) — renders off the path.
  • virtual void callback (SoCallbackAction *action) — fires the callback action.
  • virtual void getBoundingBox (SoGetBoundingBoxAction *action) — fetches the bounding box.
  • virtual void getMatrix (SoGetMatrixAction *action) — fetches the matrix.
  • virtual void pick (SoPickAction *action) — does the picking.
  • virtual void rayPick (SoRayPickAction *action) — does the ray picking. rays, slay ✨
  • virtual void search (SoSearchAction *action) — runs the search action.
  • virtual void write (SoWriteAction *action) — writes it out.
  • virtual void audioRender (SoAudioRenderAction *action) — renders the audio.
  • virtual void getPrimitiveCount (SoGetPrimitiveCountAction *action) — counts the primitives.
  • virtual void grabEventsSetup (void) — sets up event grabbing.
  • virtual void grabEventsCleanup (void) — cleans up event grabbing.
  • virtual void startNotify (void) — kicks off notification.
  • virtual void notify (SoNotList *l) — notifies the list l.
  • uint32_t getNodeId (void) const — gives you the node id.
  • virtual SoChildList * getChildren (void) const — gives you the children list.
  • virtual void writeInstance (SoOutput *out) — writes an instance to out.
  • virtual SoNode * addToCopyDict (void) const — adds itself to the copy dictionary.
  • virtual void copyContents (const SoFieldContainer *from, SbBool copyconnections) — copies the contents over from from.
  • virtual SoFieldContainer * copyThroughConnection (void) const — copies through the connection.

Public Member Functions inherited from SoFieldContainer

  • void setToDefaults (void) — resets everything to defaults.
  • SbBool hasDefaultValues (void) const — are all the values default? 👀
  • SbBool fieldsAreEqual (const SoFieldContainer *container) const — compares fields with container.
  • void copyFieldValues (const SoFieldContainer *container, SbBool copyconnections=FALSE) — copies field values from container, with copyconnections defaulting to FALSE.
  • SbBool set (const char *const fielddata) — sets from fielddata.
  • void get (SbString &fielddata) — gets into fielddata.
  • virtual int getFields (SoFieldList &l) const — fills l with the fields.
  • virtual int getAllFields (SoFieldList &l) const — fills l with all the fields, periodt.
  • virtual SoField * getField (const SbName &name) const — grabs the field called name.
  • virtual SoField * getEventIn (const SbName &name) const — grabs the eventIn called name.
  • virtual SoField * getEventOut (const SbName &name) const — grabs the eventOut called name.
  • SbBool getFieldName (const SoField *const field, SbName &name) const — figures out the name of field.
  • SbBool enableNotify (const SbBool flag) — turns notifications on or off.
  • SbBool isNotifyEnabled (void) const — is notify enabled? the vibe check.
  • SbBool set (const char *fielddata, SoInput *input) — sets from fielddata using input.
  • void get (SbString &fielddata, SoOutput *out) — gets into fielddata using out.
  • virtual SbBool validateNewFieldValue (SoField *field, void *newval) — checks if newval is valid for field.
  • virtual void addWriteReference (SoOutput *out, SbBool isfromfield=FALSE) — adds a write reference, isfromfield defaulting to FALSE.
  • SbBool getIsBuiltIn (void) const — is it built in?
  • virtual void getFieldsMemorySize (size_t &managed, size_t &unmanaged) const — reports the memory size of the fields, split into managed and unmanaged.
  • void setUserData (void *userdata) const — stashes your userdata.
  • void * getUserData (void) const — gives your userdata back.

Public Member Functions inherited from SoBase

  • void ref (void) const — bumps the ref count.
  • void unref (void) const — drops the ref count.
  • void unrefNoDelete (void) const — drops the ref count but doesn't delete. spicy 💀
  • int32_t getRefCount (void) const — how many refs we holding?
  • void touch (void) — touches it, so everybody knows something changed.
  • SbBool isOfType (SoType type) const — is it of type type?
  • virtual SbName getName (void) const — gets the name.
  • virtual void setName (const SbName &newname) — sets the name to newname.
  • void addAuditor (void *const auditor, const SoNotRec::Type type) — adds an auditor of type.
  • void removeAuditor (void *const auditor, const SoNotRec::Type type) — removes that auditor.
  • const SoAuditorList & getAuditors (void) const — gives you the auditor list.
  • SbBool shouldWrite (void) — should it write? 🤔
  • void assertAlive (void) const — asserts that it's alive. dramatic but necessary 🫶

🦋 Static Public Member Functions

  • static SoType getClassTypeId (void) — the class-level type id.
  • static void initClass (void) — initializes the class. gotta set it up before you slay.

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 uint32_t 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 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 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)

👑 Public Attributes

  • SoSFRotation offset — the offset rotation. the starting angle, if you will 💅
  • SoSFRotation rotation_changed — the rotation that gets updated when things change. the ✨main character✨ of this class, honestly.

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 — hands over the field data.
  • virtual SbBool dragStart (void) — runs when a drag starts. here we go 🎬
  • virtual void drag (void) — runs during the drag.
  • virtual void dragFinish (void) — runs when the drag is done. bye bestie 👋
  • virtual ~SoVRMLSphereSensor () — the destructor.

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

🧚 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

the NodeType enum, in all its glory:

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 }

Protected Types inherited from SoBase

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

Protected Attributes inherited from SoNode

  • uint32_t uniqueId

Protected Attributes inherited from SoFieldContainer

  • SbBool isBuiltIn

Static Protected Attributes inherited from SoNode

  • static uint32_t nextUniqueId = 1
  • static int nextActionMethodIndex = 0

and that's the whole family tree, bestie. part 2 is coming, so don't go anywhere 🎀✨

💖 DETAILED DESCRIPTION 💖

okay so bestie, the SoVRMLSphereSensor class maps pointer motion into rotations on a sphere. it's giving "spin the invisible orb" energy, fr fr.

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
}

The SphereSensor node maps pointing device motion into spherical rotation about the origin of the local coordinate system. The SphereSensor node uses the descendent geometry of its parent node to determine whether it is liable to generate events. periodt.

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. 🫶

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/x3d/specifications/vrml/ISO-IEC-14772-VRML97/part1/concepts.html#4.6.7.5), for details on using the pointing device to activate the SphereSensor.

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. 🔥

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/x3d/specifications/vrml/ISO-IEC-14772-VRML97/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. ✨

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). 😭 (lowkey chaotic of the browser, but that's the spec's call, not mine.)

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/x3d/specifications/vrml/ISO-IEC-14772-VRML97/part1/concepts.html#4.6.7.3), Pointing-device sensors, 4.6.7.4, Drag sensors (http://www.web3d.org/x3d/specifications/vrml/ISO-IEC-14772-VRML97/part1/concepts.html#4.6.7.4), and 4.6.7.5, Activating and manipulating sensors (http://www.web3d.org/x3d/specifications/vrml/ISO-IEC-14772-VRML97/part1/concepts.html#4.6.7.5).

🎀 CONSTRUCTOR & DESTRUCTOR DOCUMENTATION 🎀

SoVRMLSphereSensor::SoVRMLSphereSensor (void )

Constructor. the birth of the sensor, slay.

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

Destructor. gone but never forgotten 💜.

🌈 MEMBER FUNCTION DOCUMENTATION 🌈

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

Returns the type identification of an object derived from a class inheriting SoBase. This is used for run-time type checking and "downward" casting.

Usage example:

void foo(SoNode * node)
{
  if (node->getTypeId() == SoFile::getClassTypeId()) {
    SoFile * filenode = (SoFile *)node;  // safe downward cast, knows the type
  }
}

For application programmers wanting to extend the library with new nodes, engines, nodekits, draggers or others: this method needs to be overridden in all subclasses. This is typically done as part of setting up the full type system for extension classes, which is usually accomplished by using the pre-defined macros available through for instance Inventor/nodes/SoSubNode.h (SO_NODE_INIT_CLASS and SO_NODE_CONSTRUCTOR for node classes), Inventor/engines/SoSubEngine.h (for engine classes) and so on. 👑

For more information on writing Coin extensions, see the class documentation of the toplevel superclasses for the various class groups.

Reimplemented from SoVRMLDragSensor.

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.

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.

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.

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.

🦋 MEMBER DATA DOCUMENTATION 🦋

SoSFRotation SoVRMLSphereSensor::offset

The sensor rotation value.

SoSFRotation SoVRMLSphereSensor::rotation_changed

An eventOut that is updated during interaction. Holds the differense between the current rotation and the sensor rotation value. (yes bestie, that's literally how it's spelled in the source — i'm not fixing it, i'm just reporting it 💀)

👑 AUTHOR 👑

Generated automatically by Doxygen for Coin from the source code.

and that's the whole page, bestie!! this was Coin Version 3.1.3, and the page is SoVRMLSphereSensor(3). go forth and rotate your spheres, you absolute icon 💖✨🎀
📦 where this page comes from