.TH "SoVRMLGeometry" 3 "Thu May 29 2014" "Version 4.0.0a" "Coin" \" -*- nroff -*- .ad l .nh .SH NAME SoVRMLGeometry \- .PP The \fBSoVRMLGeometry\fP class is a superclass for VRML shapes\&. .SH SYNOPSIS .br .PP .PP \fC#include \fP .PP Inherits \fBSoShape\fP\&. .PP Inherited by \fBSoVRMLBox\fP, \fBSoVRMLCone\fP, \fBSoVRMLCylinder\fP, \fBSoVRMLElevationGrid\fP, \fBSoVRMLExtrusion\fP, \fBSoVRMLSphere\fP, \fBSoVRMLText\fP, \fBSoVRMLVertexLine\fP, \fBSoVRMLVertexPoint\fP, and \fBSoVRMLVertexShape\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 \fBsearch\fP (\fBSoSearchAction\fP *action)" .br .ti -1c .RI "virtual void \fBcopyContents\fP (const \fBSoFieldContainer\fP *from, SbBool copyConn)" .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 "Protected Member Functions" .in +1c .ti -1c .RI "virtual const \fBSoFieldData\fP * \fBgetFieldData\fP (void) const " .br .ti -1c .RI "\fBSoVRMLGeometry\fP (void)" .br .ti -1c .RI "virtual \fB~SoVRMLGeometry\fP ()" .br .ti -1c .RI "void \fBsetupShapeHints\fP (\fBSoState\fP *state, const SbBool ccw, const SbBool solid)" .br .ti -1c .RI "virtual SbBool \fBshouldGLRender\fP (\fBSoGLRenderAction\fP *action)" .br .ti -1c .RI "virtual \fBSoChildList\fP * \fBgetChildren\fP (void) const " .br .ti -1c .RI "virtual void \fBnotify\fP (\fBSoNotList\fP *list)" .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 \fBSoVRMLGeometry\fP class is a superclass for VRML shapes\&. .SH "Constructor & Destructor Documentation" .PP .SS "SoVRMLGeometry::SoVRMLGeometry (void)\fC [protected]\fP" Constructor\&. .SS "SoVRMLGeometry::~SoVRMLGeometry ()\fC [protected]\fP, \fC [virtual]\fP" Destructor\&. .SH "Member Function Documentation" .PP .SS "\fBSoType\fP SoVRMLGeometry::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 \fBSoShape\fP\&. .PP Reimplemented in \fBSoVRMLElevationGrid\fP, \fBSoVRMLVertexShape\fP, \fBSoVRMLIndexedFaceSet\fP, \fBSoVRMLIndexedLineSet\fP, \fBSoVRMLText\fP, \fBSoVRMLExtrusion\fP, \fBSoVRMLVertexPoint\fP, \fBSoVRMLCone\fP, \fBSoVRMLCylinder\fP, \fBSoVRMLVertexLine\fP, \fBSoVRMLBox\fP, \fBSoVRMLIndexedLine\fP, \fBSoVRMLIndexedShape\fP, \fBSoVRMLPointSet\fP, and \fBSoVRMLSphere\fP\&. .SS "const \fBSoFieldData\fP * SoVRMLGeometry::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 \fBSoShape\fP\&. .PP Reimplemented in \fBSoVRMLElevationGrid\fP, \fBSoVRMLVertexShape\fP, \fBSoVRMLIndexedFaceSet\fP, \fBSoVRMLIndexedLineSet\fP, \fBSoVRMLText\fP, \fBSoVRMLExtrusion\fP, \fBSoVRMLVertexPoint\fP, \fBSoVRMLCone\fP, \fBSoVRMLCylinder\fP, \fBSoVRMLVertexLine\fP, \fBSoVRMLBox\fP, \fBSoVRMLIndexedLine\fP, \fBSoVRMLIndexedShape\fP, \fBSoVRMLPointSet\fP, and \fBSoVRMLSphere\fP\&. .SS "void SoVRMLGeometry::search (\fBSoSearchAction\fP *action)\fC [virtual]\fP" Action method for \fBSoSearchAction\fP\&. .PP Compares the search criteria from the \fIaction\fP to see if this node is a match\&. Searching is done by matching up \fIall\fP criteria set up in the \fBSoSearchAction\fP -- if \fIany\fP of the requested criteria is a miss, the search is not deemed successful for the node\&. .PP \fBSee also:\fP .RS 4 \fBSoSearchAction\fP .RE .PP .PP Reimplemented from \fBSoNode\fP\&. .SS "void SoVRMLGeometry::copyContents (const \fBSoFieldContainer\fP *from, SbBoolcopyconnections)\fC [virtual]\fP" Makes a deep copy of all data of \fIfrom\fP into this instance, \fIexcept\fP external scenegraph references if \fIcopyconnections\fP is \fCFALSE\fP\&. .PP This is the method that should be overridden by extension node / engine / dragger / whatever subclasses which needs to account for internal data that are not handled automatically\&. .PP For copying nodes from application code, you should not invoke this function directly, but rather call the \fBSoNode::copy()\fP function: .PP .PP .nf SoNode * mynewnode = templatenode->copy(); .fi .PP .PP The same also goes for engines\&. .PP Make sure that when you override the \fBcopyContents()\fP method in your extension class that you also make it call upwards to it's parent superclass in the inheritance hierarchy, as \fBcopyContents()\fP in for instance \fBSoNode\fP and \fBSoFieldContainer\fP does important work\&. It should go something like this: .PP .PP .nf void MyCoinExtensionNode::copyContents(const SoFieldContainer * from, SbBool copyconnections) { // let parent superclasses do their thing (copy fields, copy // instance name, etc etc) SoNode::copyContents(from, copyconnections); // [\&.\&.then copy internal data\&.\&.] } .fi .PP .PP Reimplemented from \fBSoNode\fP\&. .SS "void SoVRMLGeometry::setupShapeHints (\fBSoState\fP *state, const SbBoolccw, const SbBoolsolid)\fC [protected]\fP" Convenience method that updates the shape hints element\&. .SS "SbBool SoVRMLGeometry::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 \fBSoShape\fP\&. .PP Reimplemented in \fBSoVRMLVertexShape\fP, \fBSoVRMLVertexPoint\fP, and \fBSoVRMLVertexLine\fP\&. .SS "\fBSoChildList\fP * SoVRMLGeometry::getChildren (void) const\fC [protected]\fP, \fC [virtual]\fP" Returns list of children for this node\&. .PP Reimplemented from \fBSoNode\fP\&. .PP Reimplemented in \fBSoVRMLText\fP\&. .SS "void SoVRMLGeometry::notify (\fBSoNotList\fP *l)\fC [protected]\fP, \fC [virtual]\fP" Notifies all auditors for this instance when changes are made\&. .PP Reimplemented from \fBSoShape\fP\&. .PP Reimplemented in \fBSoVRMLVertexShape\fP, \fBSoVRMLElevationGrid\fP, \fBSoVRMLExtrusion\fP, \fBSoVRMLText\fP, \fBSoVRMLIndexedLine\fP, \fBSoVRMLIndexedLineSet\fP, \fBSoVRMLVertexPoint\fP, \fBSoVRMLVertexLine\fP, and \fBSoVRMLIndexedShape\fP\&. .SH "Author" .PP Generated automatically by Doxygen for Coin from the source code\&.