Coin Logo http://www.sim.no
http://www.coin3d.org

SoVRMLVertexLine Class Reference

The SoVRMLVertexLine class is a superclass for line based VRML geometry. More...

#include <Inventor/VRMLnodes/SovRMLVertexLine.h>

Inheritance diagram for SoVRMLVertexLine:

SoVRMLGeometry SoShape SoNode SoFieldContainer SoBase SoVRMLIndexedLine SoVRMLIndexedLineSet

List of all members.

Public Member Functions

virtual SoType getTypeId (void) const
virtual void doAction (SoAction *action)
virtual void GLRender (SoGLRenderAction *action)
virtual void getBoundingBox (SoGetBoundingBoxAction *action)
virtual void callback (SoCallbackAction *action)
virtual void pick (SoPickAction *action)
virtual void notify (SoNotList *list)

Static Public Member Functions

static SoType getClassTypeId (void)
static void initClass (void)

Public Attributes

SoSFNode coord
SoSFNode color
SoSFBool colorPerVertex

Protected Member Functions

virtual const SoFieldDatagetFieldData (void) const
 SoVRMLVertexLine (void)
virtual ~SoVRMLVertexLine ()
virtual SbBool shouldGLRender (SoGLRenderAction *action)

Static Protected Member Functions

static const SoFieldData ** getFieldDataPtr (void)


Detailed Description

The SoVRMLVertexLine class is a superclass for line based VRML geometry.

Constructor & Destructor Documentation

SoVRMLVertexLine::SoVRMLVertexLine ( void   )  [protected]

Constructor.

References color, colorPerVertex, and coord.

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

Destructor.


Member Function Documentation

SoType SoVRMLVertexLine::getClassTypeId ( void   )  [static]

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

Reimplemented from SoVRMLGeometry.

Reimplemented in SoVRMLIndexedLine, and SoVRMLIndexedLineSet.

SoType SoVRMLVertexLine::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.

Reimplemented from SoVRMLGeometry.

Reimplemented in SoVRMLIndexedLine, and SoVRMLIndexedLineSet.

const SoFieldData ** SoVRMLVertexLine::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 SoVRMLGeometry.

Reimplemented in SoVRMLIndexedLine, and SoVRMLIndexedLineSet.

const SoFieldData * SoVRMLVertexLine::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 SoVRMLGeometry.

Reimplemented in SoVRMLIndexedLine, and SoVRMLIndexedLineSet.

void SoVRMLVertexLine::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 SoVRMLGeometry.

Reimplemented in SoVRMLIndexedLine, and SoVRMLIndexedLineSet.

void SoVRMLVertexLine::doAction ( SoAction action  )  [virtual]

This function performs the typical operation of a node for any action.

Reimplemented from SoNode.

References color, coord, SoNode::doAction(), and SoSFNode::getValue().

Referenced by SoVRMLIndexedLineSet::generatePrimitives().

void SoVRMLVertexLine::GLRender ( SoGLRenderAction action  )  [virtual]

Action method for the SoGLRenderAction.

This is called during rendering traversals. Nodes influencing the rendering state in any way or who wants to throw geometry primitives at OpenGL overrides this method.

Reimplemented from SoShape.

Reimplemented in SoVRMLIndexedLineSet.

References color, coord, SoSFNode::getValue(), and SoNode::GLRender().

void SoVRMLVertexLine::getBoundingBox ( SoGetBoundingBoxAction action  )  [virtual]

Action method for the SoGetBoundingBoxAction.

Calculates bounding box and center coordinates for node and modifies the values of the action to encompass the bounding box for this node and to shift the center point for the scene more towards the one for this node.

Nodes influencing how geometry nodes calculates their bounding box also overrides this method to change the relevant state variables.

Reimplemented from SoShape.

Reimplemented in SoVRMLIndexedLineSet.

References SoShape::getBoundingBox().

Referenced by SoVRMLIndexedLineSet::getBoundingBox().

void SoVRMLVertexLine::callback ( SoCallbackAction action  )  [virtual]

Action method for SoCallbackAction.

Simply updates the state according to how the node behaves for the render action, so the application programmer can use the SoCallbackAction for extracting information about the scene graph.

Reimplemented from SoShape.

References SoShape::callback().

void SoVRMLVertexLine::pick ( SoPickAction action  )  [virtual]

Action method for SoPickAction.

Does common processing for SoPickAction action instances.

Reimplemented from SoNode.

References SoNode::pick().

void SoVRMLVertexLine::notify ( SoNotList l  )  [virtual]

Notifies all auditors for this instance when changes are made.

Reimplemented from SoVRMLGeometry.

Reimplemented in SoVRMLIndexedLine.

References SoVRMLGeometry::notify().

Referenced by SoVRMLIndexedLine::notify().

SbBool SoVRMLVertexLine::shouldGLRender ( SoGLRenderAction action  )  [protected, virtual]

This API member is considered internal to the library, as it is not likely to be of interest to the application programmer.

Reimplemented from SoVRMLGeometry.

References coord, SoSFNode::getValue(), and SoVRMLGeometry::shouldGLRender().

Referenced by SoVRMLIndexedLineSet::GLRender().


Member Data Documentation

Can contain an SoVRMLColor node if multiple colors are wanted.

Referenced by doAction(), GLRender(), SoVRMLIndexedLineSet::GLRender(), and SoVRMLVertexLine().

When TRUE, colors will be bound per vertex, otherwise per line. Default value is TRUE.

Referenced by SoVRMLVertexLine().


The documentation for this class was generated from the following files:

Copyright © 1998-2007 by Systems in Motion AS. All rights reserved.

Generated on Mon Feb 23 16:34:10 2009 for Coin by Doxygen. 1.5.8