SoVRMLPlaneSensor(3)

📦 version 2.5.0, in fedora 43, fedora 44

💖 SoVRMLPlaneSensor(3) 💖 — Library Functions Manual

okay so bestie, gather round, because today we're reading the manual page for SoVRMLPlaneSensor and honestly? it's giving main character energy in the VRML sensor universe. this is part 1 of 2, so hydrate, sit criss-cross, and let's get into it. no cap, we're keeping every single detail, we're just doing it with ✨flavor✨.

🌸 NAME 🌸

SoVRMLPlaneSensor — the class that maps pointer motion into object space translations. like, you drag, and the object moves along a plane. periodt. 💅

✨ SYNOPSIS ✨

#include <Inventor/VRMLnodes/SoVRMLPlaneSensor>

Inherits SoVRMLDragSensor. yes bestie, it's part of a whole family tree, and we're about to meet the entire extended relatives. buckle up. 🦋

💖 Public Member Functions 💖

these are the ones that belong to this class specifically, the homegrown icons:

virtual SoType getTypeId (void) const — hands you back the type id, in a virtual way because it's an overrider, slay.
SoVRMLPlaneSensor (void) — the constructor, aka the birth of the plane sensor. iconic entrance. 🎀

🫶 Public Member Functions inherited from `SoVRMLDragSensor`

just the one, but she's important:

virtual void handleEvent (SoHandleEventAction *action)

🫶 Public Member Functions inherited from `SoNode`

okay this is a long list, so I'm putting it in a code block exactly as-is. do not perceive me struggling to make it cute, it's just a lot of methods and they're all valid:

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

another chunk, all about fields and copying and general field-container business:

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 base class, refcounting and naming and auditors, all of it:

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 class-level ones, no instance required, just vibes:

static SoType getClassTypeId (void) — the type id, but static this time.
static void initClass (void) — sets the class up. do it before you need it, bestie.

⭐ 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 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 play with on this node, and they are lowkey the whole point:

SoSFVec2f minPosition — a 2D float vector field for the minimum position. 💖
SoSFVec2f maxPosition — a 2D float vector field for the maximum position. 💖
SoSFVec3f offset — a 3D float vector field for the offset. 💖
SoSFVec3f translation_changed — a 3D float vector field that fires the translation change. 🦋

👑 Public Attributes inherited from `SoVRMLDragSensor`

SoSFVec3f trackPoint_changed
SoSFBool autoOffset

👑 Public Attributes inherited from `SoVRMLSensor`

SoSFBool isActive
SoSFBool enabled

🧚 Protected Member Functions 🧚

for the subclass girlies who need to override stuff. you can't just call these from anywhere, they're protected, respect the boundary:

virtual const SoFieldData * getFieldData (void) const — grabs the field data, virtually.
virtual SbBool dragStart (void) — called when a drag kicks off. returns a bool, make it count.
virtual void drag (void) — the drag itself, happening live.
virtual void dragFinish (void) — drag's over, cleanup era.
virtual ~SoVRMLPlaneSensor () — the destructor. virtual, protected, gone but not forgotten. 💀

🧚 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)
~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) — the pointer to the field data pointer. double pointer, double drama. 🌈

🌈 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 💅

the bonus content, the deleted scenes, the extra lore:

💅 Public Types inherited from `SoNode`

okay this enum is everything, all the node type flags, and we are listing every single one because that's the rule:

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

🫶 okay bestie that's the whole synopsis family reunion, and this is only part 1. part 2 is still loading, don't you dare close the tab, there's more lore coming and we are not done here. 💖

💖 Detailed Description 💖

okay bestie so SoVRMLPlaneSensor is the vibe that turns your pointer wiggles into actual movement through object space. it's giving translation energy ✨

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:

PlaneSensor {
  exposedField SFBool  autoOffset          TRUE
  exposedField SFBool  enabled             TRUE
  exposedField SFVec2f maxPosition         -1 -1     # (-,)
  exposedField SFVec2f minPosition         0 0       # (-,)
  exposedField SFVec3f offset              0 0 0     # (-,)
  eventOut     SFBool  isActive
  eventOut     SFVec3f trackPoint_changed
  eventOut     SFVec3f translation_changed
}

The PlaneSensor node maps pointing device motion into two-dimensional translation in a plane parallel to the Z=0 plane of the local coordinate system. The PlaneSensor node uses the descendent geometry of its parent node to determine whether it is liable to generate events. no cap, that's literally its whole job 🎀

The enabled exposedField enables and disables the PlaneSensor. 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. it's just standing there. being unbothered. 💅

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 made ready for user activation.

The PlaneSensor 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 PlaneSensor.

Upon activation of the pointing device (e.g., mouse button down) while indicating the sensor's geometry, an isActive TRUE event is sent. Pointer motion is mapped into relative translation in the tracking plane, (a plane parallel to the sensor's local Z=0 plane and coincident with the initial point of intersection). For each subsequent movement of the bearing, a translation_changed event is output which corresponds to the sum of the relative translation from the original intersection point to the intersection point of the new bearing in the plane plus the offset value. The sign of the translation is defined by the Z=0 plane of the sensor's coordinate system. 🦋

trackPoint_changed events reflect the unclamped drag position on the surface of this plane. When the pointing device is deactivated and autoOffset is TRUE, offset is set to the last translation_changed value and an offset_changed event is generated. More details are provided in 4.6.7.4, Drag sensors (http://www.web3d.org/x3d/specifications/vrml/ISO-IEC-14772-VRML97/part1/concepts.html#4.6.7.4).

When the sensor generates an isActive TRUE event, it grabs all further motion events from the pointing device until it is deactivated 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 referred to as a "drag". it's the main character now, everyone else sit down 👑

If a 2D pointing device is in use, isActive events typically reflect the state of the primary button associated with the device (i.e., isActive is TRUE when the primary button is pressed, and is FALSE when it is released).

If a 3D pointing device (e.g., wand) is in use, isActive events typically reflect whether the pointer is within or in contact with the sensor's geometry.

minPosition and maxPosition may be set to clamp translation_changed events to a range of values as measured from the origin of the Z=0 plane. If the X or Y component of minPosition is greater than the corresponding component of maxPosition, translation_changed events are not clamped in that dimension. If the X or Y component of minPosition is equal to the corresponding component of maxPosition, that component is constrained to the given value. This technique provides a way to implement a line sensor that maps dragging motion into a translation in one dimension. lowkey genius tbh 🧚

While the pointing device is activated and moved, trackPoint_changed and translation_changed events are sent. trackPoint_changed events represent the unclamped intersection points on the surface of the tracking plane. If the pointing device is dragged off of the tracking plane while activated (e.g., above horizon line), browsers may interpret this in a variety ways (e.g., clamp all values to the horizon). Each movement of the pointing device, while isActive is TRUE, generates trackPoint_changed and translation_changed events. Further information about this behaviour can be found 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).

bestie reminder: that "browsers may interpret this in a variety ways" line is doing a LOT of heavy lifting. it is undefined-ish territory, so don't go building your whole app on the assumption that dragging off the plane behaves one specific way. 🙈

🎀 Constructor & Destructor Documentation 🎀

`SoVRMLPlaneSensor::SoVRMLPlaneSensor (void )`

Constructor. that's it, that's the whole thing, it's born ✨

References maxPosition, minPosition, offset, SoVRMLPlaneSensor(), and translation_changed.

Referenced by getFieldData(), and SoVRMLPlaneSensor().

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

Destructor. bye bestie, it was real 🫶

🌈 Member Function Documentation 🌈

`SoType SoVRMLPlaneSensor::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 library figures out what it's actually looking at, no guessing 💅

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.

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 * SoVRMLPlaneSensor::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. the class-wide stash, basically 📦

Reimplemented from SoVRMLDragSensor.

References SoVRMLPlaneSensor().

`SbBool SoVRMLPlaneSensor::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. the moment of picking, iconic 🎬

Implements SoVRMLDragSensor.

References SoVRMLDragSensor::getLocalStartingPoint(), offset, and translation_changed.

`void SoVRMLPlaneSensor::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. the dragging era 💃

Implements SoVRMLDragSensor.

References SoVRMLDragSensor::getLocalStartingPoint(), SoVRMLDragSensor::getLocalToWorldMatrix(), SoVRMLDragSensor::getNormalizedLocaterPosition(), SoVRMLDragSensor::getViewVolume(), maxPosition, minPosition, offset, and translation_changed.

`void SoVRMLPlaneSensor::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. mouse up, we're done here 👋

Implements SoVRMLDragSensor.

References SoVRMLDragSensor::autoOffset, offset, and translation_changed.

🦋 Member Data Documentation 🦋

`SoSFVec2f SoVRMLPlaneSensor::minPosition`

The minimum position. the floor, the boundary, the "don't go below this" bestie 🚧

Referenced by drag(), and SoVRMLPlaneSensor().

`SoSFVec2f SoVRMLPlaneSensor::maxPosition`

The maximum position. the ceiling, the limit, the "that's far enough" ✋

Referenced by drag(), and SoVRMLPlaneSensor().

`SoSFVec3f SoVRMLPlaneSensor::offset`

Current position. Initial value is (0, 0).

Referenced by drag(), dragFinish(), dragStart(), and SoVRMLPlaneSensor().

`SoSFVec3f SoVRMLPlaneSensor::translation_changed`

An eventOut that is sent during interaction. it's the one yelling "WE MOVED" every frame 📣

Referenced by drag(), dragFinish(), dragStart(), and SoVRMLPlaneSensor().

⭐ Author ⭐

Generated automatically by Doxygen for Coin from the source code. so yeah, a robot wrote this about a robot-adjacent node, we love a full circle moment 🤖💖

and that's a wrap bestie!! this page came from Coin, Version 2.5.0, and it's the SoVRMLPlaneSensor(3) manual page. periodt. go forth and drag responsibly 💅✨🌸

📦 where this page comes from

fedora 43: Coin2-devel 2.5.0-52.fc43 · GPL-2.0-only
fedora 43: Coin2-devel 2.5.0-52.fc43 · GPL-2.0-only
fedora 44: Coin2-devel 2.5.0-54.fc44 · GPL-2.0-only
fedora 44: Coin2-devel 2.5.0-54.fc44 · GPL-2.0-only
💖 girlified by deepseek-ai/DeepSeek-V4.1-Flash on 2026-10-14: a language model's rewrite of the original, under its terms

SoVRMLPlaneSensor(3)