NAME¶

SoVRMLSensor - The SoVRMLSensor class is an abstract superclass for VRML sensors.

SYNOPSIS¶

#include <Inventor/VRMLnodes/SoVRMLSensor.h> Inherits SoNode. Inherited by SoVRMLDragSensor.

Public Member Functions¶

virtual SoType getTypeId (void) const Returns the type identification of an object derived from a class inheriting SoBase. This is used for run-time type checking and 'downward' casting.

Static Public Member Functions¶

static SoType getClassTypeId (void) This static method returns the SoType object associated with objects of this class. 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.

Public Attributes¶

SoSFBool isActive SoSFBool enabled

Protected Member Functions¶

virtual const SoFieldData * getFieldData (void) const

Static Protected Member Functions¶

static const SoFieldData ** getFieldDataPtr (void)

Additional Inherited Members¶

Detailed Description¶

The SoVRMLSensor class is an abstract superclass for VRML sensors.

Member Function Documentation¶

SoType SoVRMLSensor::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. Implements SoBase. Reimplemented in SoVRMLDragSensor, SoVRMLSphereSensor, SoVRMLCylinderSensor, and SoVRMLPlaneSensor.

const SoFieldData ** SoVRMLSensor::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. Reimplemented from SoNode. Reimplemented in SoVRMLDragSensor, SoVRMLSphereSensor, SoVRMLCylinderSensor, and SoVRMLPlaneSensor.

const SoFieldData * SoVRMLSensor::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 SoFieldContainer. Reimplemented in SoVRMLDragSensor, SoVRMLSphereSensor, SoVRMLCylinderSensor, and SoVRMLPlaneSensor.

Author¶

Generated automatically by Doxygen for Coin from the source code.