.TH "SoVRMLVertexLine" 3 "Thu May 29 2014" "Version 4.0.0a" "Coin" \" -*- nroff -*- .ad l .nh .SH NAME SoVRMLVertexLine \- .PP The \fBSoVRMLVertexLine\fP class is a superclass for line based VRML geometry\&. .SH SYNOPSIS .br .PP .PP \fC#include \fP .PP Inherits \fBSoVRMLGeometry\fP\&. .PP Inherited by \fBSoVRMLIndexedLine\fP\&. .SS "Public Member Functions" .in +1c .ti -1c .RI "virtual \fBSoType\fP \fBgetTypeId\fP (void) const " .br .RI "\fIReturns the type identification of an object derived from a class inheriting \fBSoBase\fP\&. This is used for run-time type checking and 'downward' casting\&. \fP" .ti -1c .RI "virtual void \fBdoAction\fP (\fBSoAction\fP *action)" .br .ti -1c .RI "virtual void \fBGLRender\fP (\fBSoGLRenderAction\fP *action)" .br .ti -1c .RI "virtual void \fBgetBoundingBox\fP (\fBSoGetBoundingBoxAction\fP *action)" .br .ti -1c .RI "virtual void \fBcallback\fP (\fBSoCallbackAction\fP *action)" .br .ti -1c .RI "virtual void \fBpick\fP (\fBSoPickAction\fP *action)" .br .ti -1c .RI "virtual void \fBnotify\fP (\fBSoNotList\fP *list)" .br .in -1c .SS "Static Public Member Functions" .in +1c .ti -1c .RI "static \fBSoType\fP \fBgetClassTypeId\fP (void)" .br .ti -1c .RI "static void \fBinitClass\fP (void)" .br .in -1c .SS "Public Attributes" .in +1c .ti -1c .RI "\fBSoSFNode\fP \fBcoord\fP" .br .ti -1c .RI "\fBSoSFNode\fP \fBcolor\fP" .br .ti -1c .RI "\fBSoSFBool\fP \fBcolorPerVertex\fP" .br .in -1c .SS "Protected Member Functions" .in +1c .ti -1c .RI "virtual const \fBSoFieldData\fP * \fBgetFieldData\fP (void) const " .br .ti -1c .RI "\fBSoVRMLVertexLine\fP (void)" .br .ti -1c .RI "virtual \fB~SoVRMLVertexLine\fP ()" .br .ti -1c .RI "virtual SbBool \fBshouldGLRender\fP (\fBSoGLRenderAction\fP *action)" .br .in -1c .SS "Static Protected Member Functions" .in +1c .ti -1c .RI "static const \fBSoFieldData\fP ** \fBgetFieldDataPtr\fP (void)" .br .in -1c .SS "Additional Inherited Members" .SH "Detailed Description" .PP The \fBSoVRMLVertexLine\fP class is a superclass for line based VRML geometry\&. .SH "Constructor & Destructor Documentation" .PP .SS "SoVRMLVertexLine::SoVRMLVertexLine (void)\fC [protected]\fP" Constructor\&. .SS "SoVRMLVertexLine::~SoVRMLVertexLine ()\fC [protected]\fP, \fC [virtual]\fP" Destructor\&. .SH "Member Function Documentation" .PP .SS "\fBSoType\fP SoVRMLVertexLine::getTypeId (void) const\fC [virtual]\fP" .PP Returns the type identification of an object derived from a class inheriting \fBSoBase\fP\&. This is used for run-time type checking and 'downward' casting\&. Usage example: .PP .PP .nf void foo(SoNode * node) { if (node->getTypeId() == SoFile::getClassTypeId()) { SoFile * filenode = (SoFile *)node; // safe downward cast, knows the type } } .fi .PP .PP For application programmers wanting to extend the library with new nodes, engines, nodekits, draggers or others: this method needs to be overridden in \fIall\fP 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 \fBInventor/nodes/SoSubNode\&.h\fP (SO_NODE_INIT_CLASS and SO_NODE_CONSTRUCTOR for node classes), Inventor/engines/SoSubEngine\&.h (for engine classes) and so on\&. .PP For more information on writing Coin extensions, see the class documentation of the toplevel superclasses for the various class groups\&. .PP Reimplemented from \fBSoVRMLGeometry\fP\&. .PP Reimplemented in \fBSoVRMLIndexedLineSet\fP, and \fBSoVRMLIndexedLine\fP\&. .SS "const \fBSoFieldData\fP * SoVRMLVertexLine::getFieldData (void) const\fC [protected]\fP, \fC [virtual]\fP" Returns a pointer to the class-wide field data storage object for this instance\&. If no fields are present, returns \fCNULL\fP\&. .PP Reimplemented from \fBSoVRMLGeometry\fP\&. .PP Reimplemented in \fBSoVRMLIndexedLineSet\fP, and \fBSoVRMLIndexedLine\fP\&. .SS "void SoVRMLVertexLine::doAction (\fBSoAction\fP *action)\fC [virtual]\fP" This function performs the typical operation of a node for any action\&. .PP Reimplemented from \fBSoNode\fP\&. .SS "void SoVRMLVertexLine::GLRender (\fBSoGLRenderAction\fP *action)\fC [virtual]\fP" Action method for the \fBSoGLRenderAction\fP\&. .PP 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\&. .PP Reimplemented from \fBSoShape\fP\&. .PP Reimplemented in \fBSoVRMLIndexedLineSet\fP\&. .SS "void SoVRMLVertexLine::getBoundingBox (\fBSoGetBoundingBoxAction\fP *action)\fC [virtual]\fP" Action method for the \fBSoGetBoundingBoxAction\fP\&. .PP Calculates bounding box and center coordinates for node and modifies the values of the \fIaction\fP to encompass the bounding box for this node and to shift the center point for the scene more towards the one for this node\&. .PP Nodes influencing how geometry nodes calculates their bounding box also overrides this method to change the relevant state variables\&. .PP Reimplemented from \fBSoShape\fP\&. .PP Reimplemented in \fBSoVRMLIndexedLineSet\fP\&. .SS "void SoVRMLVertexLine::callback (\fBSoCallbackAction\fP *action)\fC [virtual]\fP" Action method for \fBSoCallbackAction\fP\&. .PP Simply updates the state according to how the node behaves for the render action, so the application programmer can use the \fBSoCallbackAction\fP for extracting information about the scene graph\&. .PP Reimplemented from \fBSoShape\fP\&. .SS "void SoVRMLVertexLine::pick (\fBSoPickAction\fP *action)\fC [virtual]\fP" Action method for \fBSoPickAction\fP\&. .PP Does common processing for \fBSoPickAction\fP \fIaction\fP instances\&. .PP Reimplemented from \fBSoNode\fP\&. .SS "void SoVRMLVertexLine::notify (\fBSoNotList\fP *l)\fC [virtual]\fP" Notifies all auditors for this instance when changes are made\&. .PP Reimplemented from \fBSoVRMLGeometry\fP\&. .PP Reimplemented in \fBSoVRMLIndexedLine\fP, and \fBSoVRMLIndexedLineSet\fP\&. .SS "SbBool SoVRMLVertexLine::shouldGLRender (\fBSoGLRenderAction\fP *action)\fC [protected]\fP, \fC [virtual]\fP" \fIThis API member is considered internal to the library, as it is not likely to be of interest to the application programmer\&.\fP .PP Reimplemented from \fBSoVRMLGeometry\fP\&. .SH "Member Data Documentation" .PP .SS "\fBSoSFNode\fP SoVRMLVertexLine::coord" Should contain an \fBSoVRMLCoordinate\fP node\&. .SS "\fBSoSFNode\fP SoVRMLVertexLine::color" Can contain an \fBSoVRMLColor\fP node if multiple colors are wanted\&. .SS "\fBSoSFBool\fP SoVRMLVertexLine::colorPerVertex" When TRUE, colors will be bound per vertex, otherwise per line\&. Default value is TRUE\&. .SH "Author" .PP Generated automatically by Doxygen for Coin from the source code\&.