SoVRMLTouchSensor(3)

📦

version 2.5.0 · 2 versions

2.5.0 · fedora 43 (latest)
2.5.0 · fedora 44

SoVRMLTouchSensor 💅 ✨ the manual page ✨

okay bestie, so this is the manual page for SoVRMLTouchSensor(3) — yeah, the (3) means it lives in the library functions section of the manual, iykyk. And ngl? This one is a baddie. She tracks where the pointer is and fires off events the moment you interact with stuff. Main character energy, fr fr. 👑

✨ NAME ✨

SoVRMLTouchSensor — the class that tracks the pointer position and sends events based on user interaction. 🫶

🌸 SYNOPSIS 🌸

first things first, you gotta pull her in:

#include <Inventor/VRMLnodes/SoVRMLTouchSensor.h>

and she inherits from SoNode. classic. 💖

💅 Public Member Functions

the ones that are hers, her very own:

virtual SoType getTypeId (void) const
SoVRMLTouchSensor (void)
virtual SbBool affectsState (void) const
virtual void handleEvent (SoHandleEventAction *action)

🦋 Public Member Functions inherited from `SoNode`

she got all of this from her parent, no cap:

void setOverride (const SbBool state)
SbBool isOverride (void) const
void setNodeType (const NodeType type)
NodeType getNodeType (void) const
virtual SoNode * copy (SbBool copyconnections=0) 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)
uint32_t 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`

more family heirlooms, bestie:

void setToDefaults (void)
SbBool hasDefaultValues (void) const
SbBool fieldsAreEqual (const SoFieldContainer *container) const
void copyFieldValues (const SoFieldContainer *container, SbBool copyconnections=0)
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 *in)
void get (SbString &fielddata, SoOutput *out)
virtual SbBool validateNewFieldValue (SoField *field, void *newval)
virtual void addWriteReference (SoOutput *out, SbBool isfromfield=0)
SbBool getIsBuiltIn (void) const
void setUserData (void *userdata) const
void * getUserData (void) const

🎀 Public Member Functions inherited from `SoBase`

the OG ancestor, she passed down every single one of these:

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

⭐ Static Public Member Functions

the static girlies, no instance needed:

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 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 *in, SoBase *&base, SoType expectedtype)
static void setInstancePrefix (const SbString &c)
static void setTraceRefs (SbBool trace)
static SbBool getTraceRefs (void)
static SbBool connectRoute (SoInput *in, const SbName &fromnodename, const SbName &fromfieldname, const SbName &tonodename, const SbName &tofieldname)
static SbBool readRoute (SoInput *in)

🔥 Public Attributes

these are the fields you actually get to poke at, bestie — obsessed:

SoSFBool enabled
SoSFVec3f hitNormal_changed
SoSFVec3f hitPoint_changed
SoSFVec2f hitTexCoord_changed
SoSFBool isActive
SoSFBool isOver
SoSFTime touchTime

🙈 Protected Member Functions

protected means stay in your lane — these are for the class itself and its subclasses only:

virtual const SoFieldData * getFieldData (void) const
virtual ~SoVRMLTouchSensor ()
virtual void notify (SoNotList *list)

🌸 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)
~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 `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 👑

the lil bonus bits, the extras, if you will:

💜 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
    }

🧚 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 = 0
static int nextActionMethodIndex = 0

💖 Detailed Description 💖

okay bestie so the SoVRMLTouchSensor class tracks the pointer position and sends events based on user interaction. that's literally its whole job. slay.

the detailed class documentation here is taken verbatim from the VRML97 standard (ISO/IEC 14772-1:1997). it's copyright The Web3D Consortium, and it's used by permission of the Consortium. periodt, credit where credit's due 🫶

TouchSensor {
  exposedField SFBool  enabled TRUE
  eventOut     SFVec3f hitNormal_changed
  eventOut     SFVec3f hitPoint_changed
  eventOut     SFVec2f hitTexCoord_changed
  eventOut     SFBool  isActive
  eventOut     SFBool  isOver
  eventOut     SFTime  touchTime
}

so a TouchSensor node tracks the location and state of the pointing device, and it detects when the user points at geometry contained by the TouchSensor node's parent group. you can enable or disable a TouchSensor node by sending it an enabled event with a value of TRUE or FALSE. if the TouchSensor node is disabled, it does not track user input or send events. no input, no events, no drama 💅

the TouchSensor generates events when the pointing device points toward any geometry nodes that are descendants of the TouchSensor'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 more details on using the pointing device to activate the TouchSensor. iykyk, go read it ✨

the isOver eventOut reflects the state of the pointing device with regard to whether it's pointing towards the TouchSensor node's geometry or not. when the pointing device changes state from a position where its bearing doesn't intersect any of the TouchSensor node's geometry to one where it does intersect geometry, an isOver TRUE event is generated. when the pointing device moves from a position where its bearing intersects geometry to one where it no longer intersects the geometry — or some other geometry is obstructing the TouchSensor node's geometry — an isOver FALSE event is generated. these events are generated only when the pointing device has moved and changed the 'over' state. events are not generated if the geometry itself is animating and moving underneath the pointing device. okay so the geometry has to move you, you don't get events for it moving itself 😭

as the user moves the bearing over the TouchSensor node's geometry, the point of intersection (if any) between the bearing and the geometry is determined. each movement of the pointing device, while isOver is TRUE, generates hitPoint_changed, hitNormal_changed and hitTexCoord_changed events. hitPoint_changed events contain the 3D point on the surface of the underlying geometry, given in the TouchSensor node's coordinate system. hitNormal_changed events contain the surface normal vector at the hitPoint. hitTexCoord_changed events contain the texture coordinates of that surface at the hitPoint. the values of hitTexCoord_changed and hitNormal_changed events are computed as appropriate for the associated shape. it's giving very precise, very icon 👑

if isOver is TRUE, the user may activate the pointing device to cause the TouchSensor node to generate isActive events (e.g., by pressing the primary mouse button). when the TouchSensor node 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 — and bestie, listen, other pointing-device sensors will not generate events during this time. it's possessive, it's main character energy. motion of the pointing device while isActive is TRUE is termed a "drag."

if a 2D pointing device is in use, isActive events 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 is in use, isActive events will typically reflect whether the pointing device is within (or in contact with) the TouchSensor node's geometry. either way, it's tracking you 🫶

the eventOut field touchTime is generated when all three of the following conditions are true:

the pointing device was pointing towards the geometry when it was initially activated (isActive is TRUE).
the pointing device is currently pointing towards the geometry (isOver is TRUE).
the pointing device is deactivated (isActive FALSE event is also generated).

all three. no skipping steps. it's a whole vibe check 🌈

more information about this behaviour is described in 4.6.7.3, Pointing-device sensors (http://www.web3d.org/x3d/specifications/vrml/ISO-IEC-14772-VRML97/part1/concepts.html#4.6.7.3), 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).

the rest of this class documentation is not from the VRML97 standards documentation, but was written specifically for the Coin3D API documentation. so like, this part's original content, not a reprint 🌸

here's a small example which demonstrates use of the SoVRMLTouchSensor. click on the SoVRMLSphere to turn the SoVRMLPointLight on ✨:

#VRML V2.0 utf8

Group {
   children [
      Transform {
         children [
            DEF light PointLight {
               intensity 1
               on FALSE
            }

            Transform {
               translation -2 0 -2
               children [
                  Shape {
                     appearance Appearance {
                        material Material {
                           diffuseColor 1 0 1
                           specularColor 1 1 1
                           shininess 0.9
                        }
                     }
                     geometry Sphere { }
                  }
                  DEF touchsensor TouchSensor { }
               ]
            }
         ]
      }
   ]
   ROUTE touchsensor.isActive TO light.set_on
}

🎀 Constructor & Destructor Documentation 🎀

`SoVRMLTouchSensor::SoVRMLTouchSensor (void )`

constructor. that's it, that's the whole description 💖

References enabled, hitNormal_changed, hitPoint_changed, hitTexCoord_changed, isActive, isOver, SoVRMLTouchSensor(), and touchTime.

Referenced by getFieldData(), and SoVRMLTouchSensor().

`SoVRMLTouchSensor::~SoVRMLTouchSensor ()` `[protected]`, `[virtual]`

destructor. bye bestie 👋

✨ Member Function Documentation ✨

`SoType SoVRMLTouchSensor::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. it's how the code asks "who are you really" 💅

usage example:

void foo(SoNode * node)
{
  if (node->getTypeId() == SoFile::getClassTypeId()) {
    SoFile * filenode = (SoFile *)node;  // safe downward cast, knows the type
  }
  else if (node->getTypeId().isOfType(SoGroup::getClassTypeId())) {
    SoGroup * group = (SoGroup *)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. it's giving boilerplate but make it iconic 🌟

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

Implements SoBase.

`const SoFieldData * SoVRMLTouchSensor::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. no fields? no problem, here's a NULL 🫶

Reimplemented from SoFieldContainer.

References SoVRMLTouchSensor().

`SbBool SoVRMLTouchSensor::affectsState (void ) const` `[virtual]`

returns TRUE if the node could have any effect on the state during traversal.

if it returns FALSE, no data in the traversal-state will change from the pre-traversal state to the post-traversal state. the SoSeparator node will for instance return FALSE, as it pushes and pops the state before and after traversal of its children. all SoShape nodes will also return FALSE, as just pushing out geometry data to the rendering engine won't affect the actual rendering state.

the default method returns TRUE, on a "better safe than sorry" philosophy. honestly? respect 💜

Reimplemented from SoNode.

`void SoVRMLTouchSensor::handleEvent (SoHandleEventAction * action)` `[virtual]`

action method for SoHandleEventAction.

inspects the event data from action, and processes it if it's something which this node should react to. if it's not about you, it's not about you, moving on ✨

nodes influencing relevant state variables for how event handling is done also overrides this method.

Reimplemented from SoNode.

References SoPath::containsPath(), SoPath::copy(), SoAction::getCurPath(), SoHandleEventAction::getEvent(), SoPickedPoint::getImageToObject(), SoFullPath::getLength(), SoPickedPoint::getNormal(), SoPickedPoint::getPath(), SoHandleEventAction::getPickedPoint(), SoPickedPoint::getPoint(), SoFullPath::getTail(), SoPickedPoint::getTextureCoords(), SoPickedPoint::getWorldToObject(), SoNode::handleEvent(), hitNormal_changed, hitPoint_changed, hitTexCoord_changed, isActive, isOver, SbMatrix::multDirMatrix(), SbMatrix::multVecMatrix(), SoBase::ref(), SoNode::SoNode(), touchTime, and SoBase::unref().

`void SoVRMLTouchSensor::notify (SoNotList * l)` `[protected]`, `[virtual]`

notifies all auditors for this instance when changes are made. it's the group chat ping of the class 📣

Reimplemented from SoNode.

References SoNode::notify().

💅 MEMBER DATA DOCUMENTATION 💅

okay bestie, this is the part where we meet the actual data members — the little fields that hold the vibes (and the events) for your touch sensor. every single one, no skips, let's go 🫶

`SoSFBool` SoVRMLTouchSensor::`enabled`

TRUE means enabled. the default value is TRUE. so like, out of the box she's already awake and ready to sense your clicks ✨

referenced by SoVRMLTouchSensor().

`SoSFVec3f` SoVRMLTouchSensor::`hitNormal_changed`

an eventOut that gets sent when the pointer is hovering over some child geometry. it contains the object space normal 🦋