man SoVRMLSensor (Fonctions bibliothèques) -

NAME

SoVRMLSensor -

SYNOPSIS



#include <Inventor/VRMLnodes/SoVRMLSensor.h>

Inherits SoNode.

Inherited by SoVRMLDragSensor.

Detailed Description

The SoVRMLSensor class is an abstract superclass for VRML sensors.

Public Member Functions

virtual SoType getTypeId (void) const

Static Public Member Functions

static SoType getClassTypeId (void)

static void initClass (void)

Public Attributes

SoSFBool isActive

SoSFBool enabled

Protected Member Functions

virtual const SoFieldData * getFieldData (void) const

Static Protected Member Functions

static const SoFieldData ** getFieldDataPtr (void)

Member Function Documentation

SoType SoVRMLSensor::getClassTypeId (void) [static]

This static method returns the SoType object associated with objects of this class.

Reimplemented from SoNode.

Reimplemented in SoVRMLCylinderSensor, SoVRMLDragSensor, SoVRMLPlaneSensor, and SoVRMLSphereSensor.

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

Implements SoBase.

Reimplemented in SoVRMLCylinderSensor, SoVRMLDragSensor, SoVRMLPlaneSensor, and SoVRMLSphereSensor.

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 SoVRMLCylinderSensor, SoVRMLDragSensor, SoVRMLPlaneSensor, and SoVRMLSphereSensor.

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 SoVRMLCylinderSensor, SoVRMLDragSensor, SoVRMLPlaneSensor, and SoVRMLSphereSensor.

void SoVRMLSensor::initClass (void) [static]

Sets up initialization for data common to all instances of this class, like submitting necessary information to the Coin type system.

Reimplemented from SoNode.

Reimplemented in SoVRMLCylinderSensor, SoVRMLDragSensor, SoVRMLPlaneSensor, and SoVRMLSphereSensor.

Author

Generated automatically by Doxygen for Coin from the source code.