.TH "SoShape" 3 "Fri Sep 6 2024 15:32:06" "Version 4.0.3" "Coin" \" -*- nroff -*-
.ad l
.nh
.SH NAME
SoShape \- The \fBSoShape\fP class is the superclass for geometry shapes\&.  

.SH SYNOPSIS
.br
.PP
.PP
\fR#include <Inventor/nodes/SoShape\&.h>\fP
.PP
Inherits \fBSoNode\fP\&.
.PP
Inherited by \fBSoAsciiText\fP, \fBSoCone\fP, \fBSoCube\fP, \fBSoCylinder\fP, \fBSoImage\fP, \fBSoIndexedNurbsCurve\fP, \fBSoIndexedNurbsSurface\fP, \fBSoNurbsCurve\fP, \fBSoNurbsSurface\fP, \fBSoSphere\fP, \fBSoText2\fP, \fBSoText3\fP, \fBSoVRMLGeometry\fP, and \fBSoVertexShape\fP\&.
.SS "Public Types"

.in +1c
.ti -1c
.RI "enum \fBTriangleShape\fP { \fBTRIANGLE_STRIP\fP, \fBTRIANGLE_FAN\fP, \fBTRIANGLES\fP, \fBPOLYGON\fP, \fBQUADS\fP, \fBQUAD_STRIP\fP, \fBPOINTS\fP, \fBLINES\fP, \fBLINE_STRIP\fP }"
.br
.in -1c

Public Types inherited from \fBSoNode\fP
.in +1c
.ti -1c
.RI "enum \fBNodeType\fP { \fBINVENTOR\fP = 0x0000, \fBVRML1\fP = 0x0001, \fBVRML2\fP = 0x0002, \fBINVENTOR_1\fP = 0x0004, \fBINVENTOR_2_0\fP = 0x0008, \fBINVENTOR_2_1\fP = 0x0010, \fBINVENTOR_2_5\fP = 0x0020, \fBINVENTOR_2_6\fP = 0x0040, \fBCOIN_1_0\fP = 0x0080, \fBCOIN_2_0\fP = 0x0100, \fBEXTENSION\fP = 0x0200, \fBCOIN_2_2\fP = 0x0400, \fBCOIN_2_3\fP = 0x0800, \fBCOIN_2_4\fP = 0x1000, \fBINVENTOR_5_0\fP = 0x2000, \fBCOIN_2_5\fP = 0x4000, \fBCOIN_3_0\fP = 0x8000, \fBINVENTOR_6_0\fP = 0x10000, \fBCOIN_4_0\fP = 0x20000 }"
.br
.in -1c
.SS "Public Member Functions"

.in +1c
.ti -1c
.RI "virtual \fBSoType\fP \fBgetTypeId\fP (void) const"
.br
.ti -1c
.RI "virtual SbBool \fBaffectsState\fP (void) const"
.br
.ti -1c
.RI "virtual void \fBnotify\fP (\fBSoNotList\fP *nl)"
.br
.ti -1c
.RI "virtual void \fBgetBoundingBox\fP (\fBSoGetBoundingBoxAction\fP *action)"
.br
.ti -1c
.RI "virtual void \fBGLRender\fP (\fBSoGLRenderAction\fP *action)"
.br
.ti -1c
.RI "virtual void \fBrayPick\fP (\fBSoRayPickAction\fP *action)"
.br
.ti -1c
.RI "virtual void \fBcallback\fP (\fBSoCallbackAction\fP *action)"
.br
.ti -1c
.RI "virtual void \fBcomputeBBox\fP (\fBSoAction\fP *action, \fBSbBox3f\fP &box, \fBSbVec3f\fP &center)=0"
.br
.ti -1c
.RI "virtual void \fBgetPrimitiveCount\fP (\fBSoGetPrimitiveCountAction\fP *action)"
.br
.ti -1c
.RI "const \fBSoBoundingBoxCache\fP * \fBgetBoundingBoxCache\fP (void) const"
.br
.in -1c

Public Member Functions inherited from \fBSoNode\fP
.in +1c
.ti -1c
.RI "void \fBsetOverride\fP (const SbBool state)"
.br
.ti -1c
.RI "SbBool \fBisOverride\fP (void) const"
.br
.ti -1c
.RI "void \fBsetNodeType\fP (const \fBNodeType\fP type)"
.br
.ti -1c
.RI "\fBNodeType\fP \fBgetNodeType\fP (void) const"
.br
.ti -1c
.RI "virtual \fBSoNode\fP * \fBcopy\fP (SbBool copyconnections=FALSE) const"
.br
.ti -1c
.RI "virtual void \fBdoAction\fP (\fBSoAction\fP *action)"
.br
.ti -1c
.RI "virtual void \fBGLRenderBelowPath\fP (\fBSoGLRenderAction\fP *action)"
.br
.ti -1c
.RI "virtual void \fBGLRenderInPath\fP (\fBSoGLRenderAction\fP *action)"
.br
.ti -1c
.RI "virtual void \fBGLRenderOffPath\fP (\fBSoGLRenderAction\fP *action)"
.br
.ti -1c
.RI "virtual void \fBgetMatrix\fP (\fBSoGetMatrixAction\fP *action)"
.br
.ti -1c
.RI "virtual void \fBhandleEvent\fP (\fBSoHandleEventAction\fP *action)"
.br
.ti -1c
.RI "virtual void \fBpick\fP (\fBSoPickAction\fP *action)"
.br
.ti -1c
.RI "virtual void \fBsearch\fP (\fBSoSearchAction\fP *action)"
.br
.ti -1c
.RI "virtual void \fBwrite\fP (\fBSoWriteAction\fP *action)"
.br
.ti -1c
.RI "virtual void \fBaudioRender\fP (\fBSoAudioRenderAction\fP *action)"
.br
.ti -1c
.RI "virtual void \fBgrabEventsSetup\fP (void)"
.br
.ti -1c
.RI "virtual void \fBgrabEventsCleanup\fP (void)"
.br
.ti -1c
.RI "virtual void \fBstartNotify\fP (void)"
.br
.ti -1c
.RI "SbUniqueId \fBgetNodeId\fP (void) const"
.br
.ti -1c
.RI "virtual \fBSoChildList\fP * \fBgetChildren\fP (void) const"
.br
.ti -1c
.RI "virtual void \fBwriteInstance\fP (\fBSoOutput\fP *out)"
.br
.ti -1c
.RI "virtual \fBSoNode\fP * \fBaddToCopyDict\fP (void) const"
.br
.ti -1c
.RI "virtual void \fBcopyContents\fP (const \fBSoFieldContainer\fP *from, SbBool copyconnections)"
.br
.ti -1c
.RI "virtual \fBSoFieldContainer\fP * \fBcopyThroughConnection\fP (void) const"
.br
.in -1c

Public Member Functions inherited from \fBSoFieldContainer\fP
.in +1c
.ti -1c
.RI "void \fBsetToDefaults\fP (void)"
.br
.ti -1c
.RI "SbBool \fBhasDefaultValues\fP (void) const"
.br
.ti -1c
.RI "SbBool \fBfieldsAreEqual\fP (const \fBSoFieldContainer\fP *container) const"
.br
.ti -1c
.RI "void \fBcopyFieldValues\fP (const \fBSoFieldContainer\fP *container, SbBool copyconnections=FALSE)"
.br
.ti -1c
.RI "SbBool \fBset\fP (const char *const fielddata)"
.br
.ti -1c
.RI "void \fBget\fP (\fBSbString\fP &fielddata)"
.br
.ti -1c
.RI "virtual int \fBgetFields\fP (\fBSoFieldList\fP &l) const"
.br
.ti -1c
.RI "virtual int \fBgetAllFields\fP (\fBSoFieldList\fP &l) const"
.br
.ti -1c
.RI "virtual \fBSoField\fP * \fBgetField\fP (const \fBSbName\fP &name) const"
.br
.ti -1c
.RI "virtual \fBSoField\fP * \fBgetEventIn\fP (const \fBSbName\fP &name) const"
.br
.ti -1c
.RI "virtual \fBSoField\fP * \fBgetEventOut\fP (const \fBSbName\fP &name) const"
.br
.ti -1c
.RI "SbBool \fBgetFieldName\fP (const \fBSoField\fP *const field, \fBSbName\fP &name) const"
.br
.ti -1c
.RI "SbBool \fBenableNotify\fP (const SbBool flag)"
.br
.ti -1c
.RI "SbBool \fBisNotifyEnabled\fP (void) const"
.br
.ti -1c
.RI "SbBool \fBset\fP (const char *fielddata, \fBSoInput\fP *input)"
.br
.ti -1c
.RI "void \fBget\fP (\fBSbString\fP &fielddata, \fBSoOutput\fP *out)"
.br
.ti -1c
.RI "virtual SbBool \fBvalidateNewFieldValue\fP (\fBSoField\fP *field, void *newval)"
.br
.ti -1c
.RI "virtual void \fBaddWriteReference\fP (\fBSoOutput\fP *out, SbBool isfromfield=FALSE)"
.br
.ti -1c
.RI "SbBool \fBgetIsBuiltIn\fP (void) const"
.br
.ti -1c
.RI "virtual void \fBgetFieldsMemorySize\fP (size_t &managed, size_t &unmanaged) const"
.br
.ti -1c
.RI "void \fBsetUserData\fP (void *userdata) const"
.br
.ti -1c
.RI "void * \fBgetUserData\fP (void) const"
.br
.in -1c

Public Member Functions inherited from \fBSoBase\fP
.in +1c
.ti -1c
.RI "void \fBref\fP (void) const"
.br
.ti -1c
.RI "void \fBunref\fP (void) const"
.br
.ti -1c
.RI "void \fBunrefNoDelete\fP (void) const"
.br
.ti -1c
.RI "int32_t \fBgetRefCount\fP (void) const"
.br
.ti -1c
.RI "void \fBtouch\fP (void)"
.br
.ti -1c
.RI "SbBool \fBisOfType\fP (\fBSoType\fP type) const"
.br
.RI "Returns \fRTRUE\fP if the type of this object is either of the same type or inherited from \fItype\fP\&. "
.ti -1c
.RI "virtual \fBSbName\fP \fBgetName\fP (void) const"
.br
.ti -1c
.RI "virtual void \fBsetName\fP (const \fBSbName\fP &newname)"
.br
.ti -1c
.RI "void \fBaddAuditor\fP (void *const auditor, const \fBSoNotRec::Type\fP type)"
.br
.ti -1c
.RI "void \fBremoveAuditor\fP (void *const auditor, const \fBSoNotRec::Type\fP type)"
.br
.ti -1c
.RI "const \fBSoAuditorList\fP & \fBgetAuditors\fP (void) const"
.br
.ti -1c
.RI "SbBool \fBshouldWrite\fP (void)"
.br
.ti -1c
.RI "void \fBassertAlive\fP (void) const"
.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
.RI "Sets up initialization for data common to all instances of this class, like submitting necessary information to the Coin type system\&.    "
.ti -1c
.RI "static void \fBgetScreenSize\fP (\fBSoState\fP *const state, const \fBSbBox3f\fP &boundingbox, \fBSbVec2s\fP &rectsize)"
.br
.ti -1c
.RI "static float \fBgetDecimatedComplexity\fP (\fBSoState\fP *state, float complexity)"
.br
.in -1c

Static Public Member Functions inherited from \fBSoNode\fP
.in +1c
.ti -1c
.RI "static uint32_t \fBgetCompatibilityTypes\fP (const \fBSoType\fP &nodetype)"
.br
.ti -1c
.RI "static \fBSoType\fP \fBgetClassTypeId\fP (void)"
.br
.ti -1c
.RI "static \fBSoNode\fP * \fBgetByName\fP (const \fBSbName\fP &name)"
.br
.ti -1c
.RI "static int \fBgetByName\fP (const \fBSbName\fP &name, \fBSoNodeList\fP &l)"
.br
.ti -1c
.RI "static void \fBinitClass\fP (void)"
.br
.RI "Sets up initialization for data common to all instances of this class, like submitting necessary information to the Coin type system\&.    "
.ti -1c
.RI "static void \fBinitClasses\fP (void)"
.br
.ti -1c
.RI "static SbUniqueId \fBgetNextNodeId\fP (void)"
.br
.ti -1c
.RI "static int \fBgetActionMethodIndex\fP (const \fBSoType\fP type)"
.br
.ti -1c
.RI "static void \fBgetBoundingBoxS\fP (\fBSoAction\fP *action, \fBSoNode\fP *node)"
.br
.ti -1c
.RI "static void \fBGLRenderS\fP (\fBSoAction\fP *action, \fBSoNode\fP *node)"
.br
.ti -1c
.RI "static void \fBcallbackS\fP (\fBSoAction\fP *action, \fBSoNode\fP *node)"
.br
.ti -1c
.RI "static void \fBgetMatrixS\fP (\fBSoAction\fP *action, \fBSoNode\fP *node)"
.br
.ti -1c
.RI "static void \fBhandleEventS\fP (\fBSoAction\fP *action, \fBSoNode\fP *node)"
.br
.ti -1c
.RI "static void \fBpickS\fP (\fBSoAction\fP *action, \fBSoNode\fP *node)"
.br
.ti -1c
.RI "static void \fBrayPickS\fP (\fBSoAction\fP *action, \fBSoNode\fP *node)"
.br
.ti -1c
.RI "static void \fBsearchS\fP (\fBSoAction\fP *action, \fBSoNode\fP *node)"
.br
.ti -1c
.RI "static void \fBwriteS\fP (\fBSoAction\fP *action, \fBSoNode\fP *node)"
.br
.ti -1c
.RI "static void \fBaudioRenderS\fP (\fBSoAction\fP *action, \fBSoNode\fP *node)"
.br
.ti -1c
.RI "static void \fBgetPrimitiveCountS\fP (\fBSoAction\fP *action, \fBSoNode\fP *node)"
.br
.in -1c

Static Public Member Functions inherited from \fBSoFieldContainer\fP
.in +1c
.ti -1c
.RI "static void \fBinitClass\fP (void)"
.br
.RI "Sets up initialization for data common to all instances of this class, like submitting necessary information to the Coin type system\&.    "
.ti -1c
.RI "static \fBSoType\fP \fBgetClassTypeId\fP (void)"
.br
.RI "This static method returns the \fBSoType\fP object associated with objects of this class\&.    "
.ti -1c
.RI "static void \fBcleanupClass\fP (void)"
.br
.ti -1c
.RI "static void \fBinitCopyDict\fP (void)"
.br
.ti -1c
.RI "static void \fBaddCopy\fP (const \fBSoFieldContainer\fP *orig, const \fBSoFieldContainer\fP *copy)"
.br
.ti -1c
.RI "static \fBSoFieldContainer\fP * \fBcheckCopy\fP (const \fBSoFieldContainer\fP *orig)"
.br
.ti -1c
.RI "static \fBSoFieldContainer\fP * \fBfindCopy\fP (const \fBSoFieldContainer\fP *orig, const SbBool copyconnections)"
.br
.ti -1c
.RI "static void \fBcopyDone\fP (void)"
.br
.in -1c

Static Public Member Functions inherited from \fBSoBase\fP
.in +1c
.ti -1c
.RI "static void \fBinitClass\fP (void)"
.br
.RI "Sets up initialization for data common to all instances of this class, like submitting necessary information to the Coin type system\&. "
.ti -1c
.RI "static \fBSoType\fP \fBgetClassTypeId\fP (void)"
.br
.RI "This static method returns the \fBSoType\fP object associated with objects of this class\&. "
.ti -1c
.RI "static void \fBaddName\fP (\fBSoBase\fP *const base, const char *const name)"
.br
.ti -1c
.RI "static void \fBremoveName\fP (\fBSoBase\fP *const base, const char *const name)"
.br
.ti -1c
.RI "static void \fBincrementCurrentWriteCounter\fP (void)"
.br
.ti -1c
.RI "static void \fBdecrementCurrentWriteCounter\fP (void)"
.br
.ti -1c
.RI "static \fBSoBase\fP * \fBgetNamedBase\fP (const \fBSbName\fP &name, \fBSoType\fP type)"
.br
.ti -1c
.RI "static int \fBgetNamedBases\fP (const \fBSbName\fP &name, \fBSoBaseList\fP &baselist, \fBSoType\fP type)"
.br
.ti -1c
.RI "static SbBool \fBread\fP (\fBSoInput\fP *input, \fBSoBase\fP *&base, \fBSoType\fP expectedtype)"
.br
.ti -1c
.RI "static void \fBsetInstancePrefix\fP (const \fBSbString\fP &c)"
.br
.ti -1c
.RI "static void \fBsetTraceRefs\fP (SbBool trace)"
.br
.ti -1c
.RI "static SbBool \fBgetTraceRefs\fP (void)"
.br
.ti -1c
.RI "static SbBool \fBconnectRoute\fP (\fBSoInput\fP *input, const \fBSbName\fP &fromnodename, const \fBSbName\fP &fromfieldname, const \fBSbName\fP &tonodename, const \fBSbName\fP &tofieldname)"
.br
.ti -1c
.RI "static SbBool \fBreadRoute\fP (\fBSoInput\fP *input)"
.br
.in -1c
.SS "Protected Member Functions"

.in +1c
.ti -1c
.RI "virtual const \fBSoFieldData\fP * \fBgetFieldData\fP (void) const"
.br
.ti -1c
.RI "\fBSoShape\fP (void)"
.br
.ti -1c
.RI "virtual \fB~SoShape\fP ()"
.br
.ti -1c
.RI "float \fBgetComplexityValue\fP (\fBSoAction\fP *action)"
.br
.ti -1c
.RI "virtual void \fBgeneratePrimitives\fP (\fBSoAction\fP *action)=0"
.br
.ti -1c
.RI "virtual SbBool \fBshouldGLRender\fP (\fBSoGLRenderAction\fP *action)"
.br
.ti -1c
.RI "void \fBbeginSolidShape\fP (\fBSoGLRenderAction\fP *action)"
.br
.ti -1c
.RI "void \fBendSolidShape\fP (\fBSoGLRenderAction\fP *action)"
.br
.ti -1c
.RI "void \fBGLRenderBoundingBox\fP (\fBSoGLRenderAction\fP *action)"
.br
.ti -1c
.RI "SbBool \fBshouldPrimitiveCount\fP (\fBSoGetPrimitiveCountAction\fP *action)"
.br
.ti -1c
.RI "SbBool \fBshouldRayPick\fP (\fBSoRayPickAction\fP *const action)"
.br
.ti -1c
.RI "void \fBcomputeObjectSpaceRay\fP (\fBSoRayPickAction\fP *const action)"
.br
.ti -1c
.RI "void \fBcomputeObjectSpaceRay\fP (\fBSoRayPickAction\fP *const action, const \fBSbMatrix\fP &matrix)"
.br
.ti -1c
.RI "virtual \fBSoDetail\fP * \fBcreateTriangleDetail\fP (\fBSoRayPickAction\fP *action, const \fBSoPrimitiveVertex\fP *v1, const \fBSoPrimitiveVertex\fP *v2, const \fBSoPrimitiveVertex\fP *v3, \fBSoPickedPoint\fP *pp)"
.br
.ti -1c
.RI "virtual \fBSoDetail\fP * \fBcreateLineSegmentDetail\fP (\fBSoRayPickAction\fP *action, const \fBSoPrimitiveVertex\fP *v1, const \fBSoPrimitiveVertex\fP *v2, \fBSoPickedPoint\fP *pp)"
.br
.ti -1c
.RI "virtual \fBSoDetail\fP * \fBcreatePointDetail\fP (\fBSoRayPickAction\fP *action, const \fBSoPrimitiveVertex\fP *v, \fBSoPickedPoint\fP *pp)"
.br
.ti -1c
.RI "void \fBinvokeTriangleCallbacks\fP (\fBSoAction\fP *const action, const \fBSoPrimitiveVertex\fP *const v1, const \fBSoPrimitiveVertex\fP *const v2, const \fBSoPrimitiveVertex\fP *const v3)"
.br
.ti -1c
.RI "void \fBinvokeLineSegmentCallbacks\fP (\fBSoAction\fP *const action, const \fBSoPrimitiveVertex\fP *const v1, const \fBSoPrimitiveVertex\fP *const v2)"
.br
.ti -1c
.RI "void \fBinvokePointCallbacks\fP (\fBSoAction\fP *const action, const \fBSoPrimitiveVertex\fP *const v)"
.br
.ti -1c
.RI "void \fBbeginShape\fP (\fBSoAction\fP *const action, const \fBTriangleShape\fP shapetype, \fBSoDetail\fP *const detail=NULL)"
.br
.ti -1c
.RI "void \fBshapeVertex\fP (const \fBSoPrimitiveVertex\fP *const v)"
.br
.ti -1c
.RI "void \fBendShape\fP (void)"
.br
.ti -1c
.RI "void \fBgenerateVertex\fP (\fBSoPrimitiveVertex\fP *const pv, const \fBSbVec3f\fP &point, const SbBool useTexFunc, const \fBSoMultiTextureCoordinateElement\fP *const tce, const float s, const float t, const \fBSbVec3f\fP &normal)"
.br
.ti -1c
.RI "void \fBgenerateVertex\fP (\fBSoPrimitiveVertex\fP *const pv, const \fBSbVec3f\fP &point, const SbBool useTexFunc, const \fBSoMultiTextureCoordinateElement\fP *const tce, const float s, const float t, const float r, const \fBSbVec3f\fP &normal)"
.br
.ti -1c
.RI "SbBool \fBstartVertexArray\fP (\fBSoGLRenderAction\fP *action, const \fBSoCoordinateElement\fP *coords, const \fBSbVec3f\fP *pervertexnormals, const SbBool texpervertex, const SbBool colorpervertex)"
.br
.ti -1c
.RI "void \fBfinishVertexArray\fP (\fBSoGLRenderAction\fP *action, const SbBool vbo, const SbBool normpervertex, const SbBool texpervertex, const SbBool colorpervertex)"
.br
.in -1c

Protected Member Functions inherited from \fBSoNode\fP
.in +1c
.ti -1c
.RI "\fBSoNode\fP (void)"
.br
.ti -1c
.RI "virtual \fB~SoNode\fP ()"
.br
.ti -1c
.RI "virtual SbBool \fBreadInstance\fP (\fBSoInput\fP *in, unsigned short flags)"
.br
.in -1c

Protected Member Functions inherited from \fBSoFieldContainer\fP
.in +1c
.ti -1c
.RI "\fBSoFieldContainer\fP (void)"
.br
.ti -1c
.RI "virtual \fB~SoFieldContainer\fP ()"
.br
.in -1c

Protected Member Functions inherited from \fBSoBase\fP
.in +1c
.ti -1c
.RI "\fBSoBase\fP (void)"
.br
.ti -1c
.RI "virtual \fB~SoBase\fP ()"
.br
.ti -1c
.RI "virtual void \fBdestroy\fP (void)"
.br
.ti -1c
.RI "SbBool \fBhasMultipleWriteRefs\fP (void) const"
.br
.ti -1c
.RI "SbBool \fBwriteHeader\fP (\fBSoOutput\fP *out, SbBool isgroup, SbBool isengine) const"
.br
.ti -1c
.RI "void \fBwriteFooter\fP (\fBSoOutput\fP *out) const"
.br
.ti -1c
.RI "virtual const char * \fBgetFileFormatName\fP (void) const"
.br
.ti -1c
.RI "virtual \fBSoNotRec\fP \fBcreateNotRec\fP (void)"
.br
.in -1c
.SS "Static Protected Member Functions"

.in +1c
.ti -1c
.RI "static const \fBSoFieldData\fP ** \fBgetFieldDataPtr\fP (void)"
.br
.in -1c

Static Protected Member Functions inherited from \fBSoNode\fP
.in +1c
.ti -1c
.RI "static const \fBSoFieldData\fP ** \fBgetFieldDataPtr\fP (void)"
.br
.ti -1c
.RI "static void \fBsetNextActionMethodIndex\fP (int index)"
.br
.ti -1c
.RI "static int \fBgetNextActionMethodIndex\fP (void)"
.br
.ti -1c
.RI "static void \fBincNextActionMethodIndex\fP (void)"
.br
.ti -1c
.RI "static void \fBsetCompatibilityTypes\fP (const \fBSoType\fP &nodetype, const uint32_t bitmask)"
.br
.in -1c

Static Protected Member Functions inherited from \fBSoBase\fP
.in +1c
.ti -1c
.RI "static uint32_t \fBgetCurrentWriteCounter\fP (void)"
.br
.ti -1c
.RI "static void \fBstaticDataLock\fP (void)"
.br
.ti -1c
.RI "static void \fBstaticDataUnlock\fP (void)"
.br
.in -1c
.SS "Additional Inherited Members"


Public Attributes inherited from \fBSoBase\fP

Protected Types inherited from \fBSoBase\fP
.in +1c
.ti -1c
.RI "enum \fBBaseFlags\fP { \fBIS_ENGINE\fP = 0x01, \fBIS_GROUP\fP = 0x02 }"
.br
.in -1c

Protected Attributes inherited from \fBSoNode\fP
.in +1c
.ti -1c
.RI "SbUniqueId \fBuniqueId\fP"
.br
.in -1c

Protected Attributes inherited from \fBSoFieldContainer\fP
.in +1c
.ti -1c
.RI "SbBool \fBisBuiltIn\fP"
.br
.in -1c

Static Protected Attributes inherited from \fBSoNode\fP
.in +1c
.ti -1c
.RI "static SbUniqueId \fBnextUniqueId\fP = 1"
.br
.ti -1c
.RI "static int \fBnextActionMethodIndex\fP = 0"
.br
.in -1c
.SH "Detailed Description"
.PP 
The \fBSoShape\fP class is the superclass for geometry shapes\&. 

The node types which have actual geometry to render inherit this class\&. For convenience, the \fBSoShape\fP class contains various common code used by the subclasses\&. 
.SH "Member Enumeration Documentation"
.PP 
.SS "enum \fBSoShape::TriangleShape\fP"
\fIThis API member is considered internal to the library, as it is not likely to be of interest to the application programmer\&.\fP
.br

.br

.SH "Constructor & Destructor Documentation"
.PP 
.SS "SoShape::SoShape (void )\fR [protected]\fP"
Constructor\&. 
.SS "SoShape::~SoShape ()\fR [protected]\fP, \fR [virtual]\fP"
Destructor\&. 
.SH "Member Function Documentation"
.PP 
.SS "\fBSoType\fP SoShape::getClassTypeId (void )\fR [static]\fP"
This static method returns the \fBSoType\fP object associated with objects of this class\&. 
.br
 
.SS "\fBSoType\fP SoShape::getTypeId (void ) const\fR [virtual]\fP"
Returns the type identification of an object derived from a class inheriting \fBSoBase\fP\&. This is used for runtime type checking and 'downward' casting\&. 
.br
 
.PP
Implements \fBSoBase\fP\&.
.PP
Reimplemented in \fBSoAsciiText\fP, \fBSoCone\fP, \fBSoCube\fP, \fBSoCylinder\fP, \fBSoFaceSet\fP, \fBSoImage\fP, \fBSoIndexedFaceSet\fP, \fBSoIndexedLineSet\fP, \fBSoIndexedMarkerSet\fP, \fBSoIndexedNurbsCurve\fP, \fBSoIndexedNurbsSurface\fP, \fBSoIndexedPointSet\fP, \fBSoIndexedShape\fP, \fBSoIndexedTriangleStripSet\fP, \fBSoLineSet\fP, \fBSoMarkerSet\fP, \fBSoNonIndexedShape\fP, \fBSoNurbsCurve\fP, \fBSoNurbsSurface\fP, \fBSoPointSet\fP, \fBSoQuadMesh\fP, \fBSoSphere\fP, \fBSoText2\fP, \fBSoText3\fP, \fBSoTriangleStripSet\fP, \fBSoVertexShape\fP, \fBSoVRMLBox\fP, \fBSoVRMLCone\fP, \fBSoVRMLCylinder\fP, \fBSoVRMLElevationGrid\fP, \fBSoVRMLExtrusion\fP, \fBSoVRMLGeometry\fP, \fBSoVRMLIndexedFaceSet\fP, \fBSoVRMLIndexedLine\fP, \fBSoVRMLIndexedLineSet\fP, \fBSoVRMLIndexedShape\fP, \fBSoVRMLPointSet\fP, \fBSoVRMLSphere\fP, \fBSoVRMLText\fP, \fBSoVRMLVertexLine\fP, \fBSoVRMLVertexPoint\fP, and \fBSoVRMLVertexShape\fP\&.
.SS "const \fBSoFieldData\fP ** SoShape::getFieldDataPtr (void )\fR [static]\fP, \fR [protected]\fP"
\fIThis API member is considered internal to the library, as it is not likely to be of interest to the application programmer\&.\fP
.br

.br
 Returns the \fBSoFieldData\fP class which holds information about fields in this node\&. 
.br
 
.SS "const \fBSoFieldData\fP * SoShape::getFieldData (void ) const\fR [protected]\fP, \fR [virtual]\fP"
Returns a pointer to the class-wide field data storage object for this instance\&. If no fields are present, returns \fRNULL\fP\&. 
.PP
Reimplemented from \fBSoFieldContainer\fP\&.
.PP
Reimplemented in \fBSoAsciiText\fP, \fBSoCone\fP, \fBSoCube\fP, \fBSoCylinder\fP, \fBSoFaceSet\fP, \fBSoImage\fP, \fBSoIndexedFaceSet\fP, \fBSoIndexedLineSet\fP, \fBSoIndexedMarkerSet\fP, \fBSoIndexedNurbsCurve\fP, \fBSoIndexedNurbsSurface\fP, \fBSoIndexedPointSet\fP, \fBSoIndexedShape\fP, \fBSoIndexedTriangleStripSet\fP, \fBSoLineSet\fP, \fBSoMarkerSet\fP, \fBSoNonIndexedShape\fP, \fBSoNurbsCurve\fP, \fBSoNurbsSurface\fP, \fBSoPointSet\fP, \fBSoQuadMesh\fP, \fBSoSphere\fP, \fBSoText2\fP, \fBSoText3\fP, \fBSoTriangleStripSet\fP, \fBSoVertexShape\fP, \fBSoVRMLBox\fP, \fBSoVRMLCone\fP, \fBSoVRMLCylinder\fP, \fBSoVRMLElevationGrid\fP, \fBSoVRMLExtrusion\fP, \fBSoVRMLGeometry\fP, \fBSoVRMLIndexedFaceSet\fP, \fBSoVRMLIndexedLine\fP, \fBSoVRMLIndexedLineSet\fP, \fBSoVRMLIndexedShape\fP, \fBSoVRMLPointSet\fP, \fBSoVRMLSphere\fP, \fBSoVRMLText\fP, \fBSoVRMLVertexLine\fP, \fBSoVRMLVertexPoint\fP, and \fBSoVRMLVertexShape\fP\&.
.SS "SbBool SoShape::affectsState (void ) const\fR [virtual]\fP"
Returns \fRTRUE\fP if the node could have any effect on the state during traversal\&.

.PP
If it returns \fRFALSE\fP, no data in the traversal state will change from the pre-traversal state to the post-traversal state\&. The \fBSoSeparator\fP node will for instance return \fRFALSE\fP, as it pushes and pops the state before and after traversal of its children\&. All \fBSoShape\fP nodes will also return \fRFALSE\fP, as just pushing out geometry data to the rendering engine won't affect the actual rendering state\&.

.PP
The default method returns \fRTRUE\fP, on a 'better safe than sorry' philosophy\&. 
.PP
Reimplemented from \fBSoNode\fP\&.
.SS "void SoShape::notify (\fBSoNotList\fP * l)\fR [virtual]\fP"
Notifies all auditors for this instance when changes are made\&. 
.PP
Reimplemented from \fBSoNode\fP\&.
.PP
Reimplemented in \fBSoAsciiText\fP, \fBSoImage\fP, \fBSoIndexedLineSet\fP, \fBSoIndexedPointSet\fP, \fBSoText3\fP, \fBSoVertexShape\fP, \fBSoVRMLElevationGrid\fP, \fBSoVRMLExtrusion\fP, \fBSoVRMLGeometry\fP, \fBSoVRMLIndexedLine\fP, \fBSoVRMLIndexedLineSet\fP, \fBSoVRMLIndexedShape\fP, \fBSoVRMLText\fP, \fBSoVRMLVertexLine\fP, \fBSoVRMLVertexPoint\fP, and \fBSoVRMLVertexShape\fP\&.
.SS "void SoShape::getBoundingBox (\fBSoGetBoundingBoxAction\fP * action)\fR [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 calculate their bounding box also override this method to change the relevant state variables\&. 
.PP
Reimplemented from \fBSoNode\fP\&.
.PP
Reimplemented in \fBSoIndexedLineSet\fP, \fBSoIndexedNurbsCurve\fP, \fBSoIndexedPointSet\fP, \fBSoLineSet\fP, \fBSoNurbsCurve\fP, \fBSoPointSet\fP, \fBSoVRMLIndexedLineSet\fP, \fBSoVRMLPointSet\fP, \fBSoVRMLVertexLine\fP, \fBSoVRMLVertexPoint\fP, and \fBSoVRMLVertexShape\fP\&.
.SS "void SoShape::GLRender (\fBSoGLRenderAction\fP * action)\fR [virtual]\fP"
Action method for the \fBSoGLRenderAction\fP\&.

.PP
This is called during rendering traversals\&. Nodes influencing the rendering state in any way or want to throw geometry primitives at OpenGL override this method\&. 
.PP
Reimplemented from \fBSoNode\fP\&.
.PP
Reimplemented in \fBSoAsciiText\fP, \fBSoCone\fP, \fBSoCube\fP, \fBSoCylinder\fP, \fBSoFaceSet\fP, \fBSoImage\fP, \fBSoIndexedFaceSet\fP, \fBSoIndexedLineSet\fP, \fBSoIndexedMarkerSet\fP, \fBSoIndexedNurbsCurve\fP, \fBSoIndexedNurbsSurface\fP, \fBSoIndexedPointSet\fP, \fBSoIndexedTriangleStripSet\fP, \fBSoLineSet\fP, \fBSoMarkerSet\fP, \fBSoNurbsCurve\fP, \fBSoNurbsSurface\fP, \fBSoPointSet\fP, \fBSoQuadMesh\fP, \fBSoSphere\fP, \fBSoText2\fP, \fBSoText3\fP, \fBSoTriangleStripSet\fP, \fBSoVRMLBox\fP, \fBSoVRMLCone\fP, \fBSoVRMLCylinder\fP, \fBSoVRMLElevationGrid\fP, \fBSoVRMLExtrusion\fP, \fBSoVRMLIndexedFaceSet\fP, \fBSoVRMLIndexedLineSet\fP, \fBSoVRMLPointSet\fP, \fBSoVRMLSphere\fP, \fBSoVRMLText\fP, \fBSoVRMLVertexLine\fP, \fBSoVRMLVertexPoint\fP, and \fBSoVRMLVertexShape\fP\&.
.SS "void SoShape::rayPick (\fBSoRayPickAction\fP * action)\fR [virtual]\fP"
Calculates picked point based on primitives generated by subclasses\&. 
.PP
Reimplemented from \fBSoNode\fP\&.
.PP
Reimplemented in \fBSoCone\fP, \fBSoCube\fP, \fBSoCylinder\fP, \fBSoImage\fP, \fBSoIndexedNurbsCurve\fP, \fBSoIndexedNurbsSurface\fP, \fBSoNurbsCurve\fP, \fBSoNurbsSurface\fP, \fBSoSphere\fP, \fBSoText2\fP, \fBSoVRMLBox\fP, \fBSoVRMLCone\fP, \fBSoVRMLCylinder\fP, \fBSoVRMLElevationGrid\fP, and \fBSoVRMLSphere\fP\&.
.SS "void SoShape::callback (\fBSoCallbackAction\fP * action)\fR [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 \fBSoNode\fP\&.
.PP
Reimplemented in \fBSoVRMLVertexLine\fP, \fBSoVRMLVertexPoint\fP, and \fBSoVRMLVertexShape\fP\&.
.SS "virtual void SoShape::computeBBox (\fBSoAction\fP * action, \fBSbBox3f\fP & box, \fBSbVec3f\fP & center)\fR [pure virtual]\fP"
Implemented by \fBSoShape\fP subclasses to let the \fBSoShape\fP superclass know the exact size and weighted center point of the shape's bounding box\&.

.PP
The bounding box and center point should be calculated and returned in the local coordinate system\&.

.PP
The method implements action behavior for shape nodes for \fBSoGetBoundingBoxAction\fP\&. It is invoked from \fBSoShape::getBoundingBox()\fP\&. (Subclasses should \fInot\fP override \fBSoNode::getBoundingBox()\fP\&.)

.PP
The \fIbox\fP parameter sent in is guaranteed to be an empty box, while \fIcenter\fP is undefined upon function entry\&. 
.PP
Implemented in \fBSoAsciiText\fP, \fBSoCone\fP, \fBSoCube\fP, \fBSoCylinder\fP, \fBSoFaceSet\fP, \fBSoImage\fP, \fBSoIndexedNurbsCurve\fP, \fBSoIndexedNurbsSurface\fP, \fBSoIndexedShape\fP, \fBSoLineSet\fP, \fBSoNurbsCurve\fP, \fBSoNurbsSurface\fP, \fBSoPointSet\fP, \fBSoQuadMesh\fP, \fBSoSphere\fP, \fBSoText2\fP, \fBSoText3\fP, \fBSoTriangleStripSet\fP, \fBSoVRMLBox\fP, \fBSoVRMLCone\fP, \fBSoVRMLCylinder\fP, \fBSoVRMLElevationGrid\fP, \fBSoVRMLExtrusion\fP, \fBSoVRMLIndexedLine\fP, \fBSoVRMLIndexedShape\fP, \fBSoVRMLSphere\fP, \fBSoVRMLText\fP, and \fBSoVRMLVertexPoint\fP\&.
.SS "void SoShape::getPrimitiveCount (\fBSoGetPrimitiveCountAction\fP * action)\fR [virtual]\fP"
Action method for the \fBSoGetPrimitiveCountAction\fP\&.

.PP
Calculates the number of triangle, line segment and point primitives for the node and adds these to the counters of the \fIaction\fP\&.

.PP
Nodes influencing how geometry nodes calculate their primitive count also override this method to change the relevant state variables\&. 
.PP
Reimplemented from \fBSoNode\fP\&.
.PP
Reimplemented in \fBSoAsciiText\fP, \fBSoCone\fP, \fBSoCube\fP, \fBSoCylinder\fP, \fBSoFaceSet\fP, \fBSoImage\fP, \fBSoIndexedFaceSet\fP, \fBSoIndexedLineSet\fP, \fBSoIndexedNurbsCurve\fP, \fBSoIndexedNurbsSurface\fP, \fBSoIndexedPointSet\fP, \fBSoIndexedTriangleStripSet\fP, \fBSoLineSet\fP, \fBSoMarkerSet\fP, \fBSoNurbsCurve\fP, \fBSoNurbsSurface\fP, \fBSoPointSet\fP, \fBSoQuadMesh\fP, \fBSoSphere\fP, \fBSoText2\fP, \fBSoText3\fP, \fBSoTriangleStripSet\fP, \fBSoVRMLBox\fP, \fBSoVRMLCone\fP, \fBSoVRMLCylinder\fP, \fBSoVRMLElevationGrid\fP, \fBSoVRMLExtrusion\fP, \fBSoVRMLIndexedFaceSet\fP, \fBSoVRMLIndexedLineSet\fP, \fBSoVRMLSphere\fP, \fBSoVRMLText\fP, and \fBSoVRMLVertexPoint\fP\&.
.SS "void SoShape::getScreenSize (\fBSoState\fP *const state, const \fBSbBox3f\fP & boundingbox, \fBSbVec2s\fP & rectsize)\fR [static]\fP"
A convenience function that returns the size of a \fIboundingbox\fP projected onto the screen\&. Useful for \fRSCREEN_SPACE\fP complexity geometry\&. 
.SS "float SoShape::getDecimatedComplexity (\fBSoState\fP * state, float complexity)\fR [static]\fP"
Not implemented in Coin\&. Should probably have been private in TGS Inventor API\&. 
.SS "const \fBSoBoundingBoxCache\fP * SoShape::getBoundingBoxCache (void ) const"
Return the bounding box cache for this shape\&. It might return NULL if no bounding box cache has been created\&. If not NULL, the caller must check if the cache is valid before using it\&. This can be done using \fBSoCache::isValid()\fP\&.

.PP
This function is an extension for Coin, and it is not available in the original SGI Open Inventor v2\&.1 API\&.
.br
 
.PP
\fBSince\fP
.RS 4
Coin 2\&.0 
.RE
.PP

.SS "float SoShape::getComplexityValue (\fBSoAction\fP * action)\fR [protected]\fP"
Returns the complexity value to be used by subclasses\&. Considers complexity type\&. For \fROBJECT_SPACE\fP complexity this will be a number between 0 and 1\&. For \fRSCREEN_SPACE\fP complexity it is a number from 0 and up\&. 
.SS "virtual void SoShape::generatePrimitives (\fBSoAction\fP * action)\fR [protected]\fP, \fR [pure virtual]\fP"
The method implements action behavior for shape nodes for \fBSoCallbackAction\fP\&. It is invoked from \fBSoShape::callback()\fP\&. (Subclasses should \fInot\fP override \fBSoNode::callback()\fP\&.)

.PP
The subclass implementations uses the convenience methods \fBSoShape::beginShape()\fP, \fBSoShape::shapeVertex()\fP, and \fBSoShape::endShape()\fP, with \fBSoDetail\fP instances, to pass the primitives making up the shape back to the caller\&. 
.PP
Implemented in \fBSoAsciiText\fP, \fBSoCone\fP, \fBSoCube\fP, \fBSoCylinder\fP, \fBSoFaceSet\fP, \fBSoImage\fP, \fBSoIndexedFaceSet\fP, \fBSoIndexedNurbsCurve\fP, \fBSoIndexedNurbsSurface\fP, \fBSoIndexedPointSet\fP, \fBSoIndexedTriangleStripSet\fP, \fBSoLineSet\fP, \fBSoNurbsCurve\fP, \fBSoNurbsSurface\fP, \fBSoPointSet\fP, \fBSoQuadMesh\fP, \fBSoSphere\fP, \fBSoText2\fP, \fBSoText3\fP, \fBSoTriangleStripSet\fP, \fBSoVRMLBox\fP, \fBSoVRMLCone\fP, \fBSoVRMLCylinder\fP, \fBSoVRMLElevationGrid\fP, \fBSoVRMLExtrusion\fP, \fBSoVRMLIndexedFaceSet\fP, \fBSoVRMLIndexedLineSet\fP, \fBSoVRMLPointSet\fP, \fBSoVRMLSphere\fP, and \fBSoVRMLText\fP\&.
.SS "SbBool SoShape::shouldGLRender (\fBSoGLRenderAction\fP * action)\fR [protected]\fP, \fR [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
.br

.br

.PP
Reimplemented in \fBSoVertexShape\fP, \fBSoVRMLGeometry\fP, \fBSoVRMLVertexLine\fP, \fBSoVRMLVertexPoint\fP, and \fBSoVRMLVertexShape\fP\&.
.SS "void SoShape::beginSolidShape (\fBSoGLRenderAction\fP * action)\fR [protected]\fP"
\fIThis API member is considered internal to the library, as it is not likely to be of interest to the application programmer\&.\fP
.br

.br

.SS "void SoShape::endSolidShape (\fBSoGLRenderAction\fP * action)\fR [protected]\fP"
\fIThis API member is considered internal to the library, as it is not likely to be of interest to the application programmer\&.\fP
.br

.br

.SS "void SoShape::GLRenderBoundingBox (\fBSoGLRenderAction\fP * action)\fR [protected]\fP"
Render a bounding box\&. 
.SS "SbBool SoShape::shouldPrimitiveCount (\fBSoGetPrimitiveCountAction\fP * action)\fR [protected]\fP"
\fIThis API member is considered internal to the library, as it is not likely to be of interest to the application programmer\&.\fP
.br

.br

.SS "SbBool SoShape::shouldRayPick (\fBSoRayPickAction\fP *const action)\fR [protected]\fP"
\fIThis API member is considered internal to the library, as it is not likely to be of interest to the application programmer\&.\fP
.br

.br

.SS "void SoShape::computeObjectSpaceRay (\fBSoRayPickAction\fP *const action)\fR [protected]\fP"
\fIThis API member is considered internal to the library, as it is not likely to be of interest to the application programmer\&.\fP
.br

.br

.SS "void SoShape::computeObjectSpaceRay (\fBSoRayPickAction\fP *const action, const \fBSbMatrix\fP & matrix)\fR [protected]\fP"
\fIThis API member is considered internal to the library, as it is not likely to be of interest to the application programmer\&.\fP
.br

.br

.SS "\fBSoDetail\fP * SoShape::createTriangleDetail (\fBSoRayPickAction\fP * action, const \fBSoPrimitiveVertex\fP * v1, const \fBSoPrimitiveVertex\fP * v2, const \fBSoPrimitiveVertex\fP * v3, \fBSoPickedPoint\fP * pp)\fR [protected]\fP, \fR [virtual]\fP"
Will create triangle detail for a \fBSoPickedPoint\fP\&. This method will only be called internally, when \fBgeneratePrimitives()\fP is used for picking (\fBSoShape::rayPick()\fP is not overridden)\&.

.PP
This method returns \fRNULL\fP in Open Inventor, and subclasses will need to override this method to create details for a \fBSoPickedPoint\fP\&.

.PP
This is not necessary with Coin\&. Of course, if you choose to override it, it will work in the same way as Open Inventor\&.

.PP
For this to work, you must supply a face or line detail when generating primitives\&. If you supply \fRNULL\fP for the detail argument in \fBSoShape::beginShape()\fP, you'll have to override this method\&. 
.PP
Reimplemented in \fBSoAsciiText\fP, \fBSoIndexedNurbsSurface\fP, \fBSoNurbsSurface\fP, \fBSoText3\fP, and \fBSoVRMLExtrusion\fP\&.
.SS "\fBSoDetail\fP * SoShape::createLineSegmentDetail (\fBSoRayPickAction\fP * action, const \fBSoPrimitiveVertex\fP * v1, const \fBSoPrimitiveVertex\fP * v2, \fBSoPickedPoint\fP * pp)\fR [protected]\fP, \fR [virtual]\fP"
Will create line detail for a \fBSoPickedPoint\fP\&. This method will only be called internally, when \fBgeneratePrimitives()\fP is used for picking (\fBSoShape::rayPick()\fP is not overridden)\&.

.PP
This method returns \fRNULL\fP in Open Inventor, and subclasses will need to override this method to create details for a \fBSoPickedPoint\fP\&.

.PP
This is not necessary with Coin\&. Of course, if you choose to override it, it will work in the same way as Open Inventor\&.

.PP
For this to work, you must supply a face or line detail when generating primitives\&. If you supply \fRNULL\fP for the detail argument in \fBSoShape::beginShape()\fP, you'll have to override this method\&. 
.PP
Reimplemented in \fBSoIndexedNurbsCurve\fP, and \fBSoNurbsCurve\fP\&.
.SS "\fBSoDetail\fP * SoShape::createPointDetail (\fBSoRayPickAction\fP * action, const \fBSoPrimitiveVertex\fP * v, \fBSoPickedPoint\fP * pp)\fR [protected]\fP, \fR [virtual]\fP"
Will create point detail for a \fBSoPickedPoint\fP\&. This method will only be called internally, when \fBgeneratePrimitives()\fP is used for picking (\fBSoShape::rayPick()\fP is not overridden)\&.

.PP
This method returns \fRNULL\fP in Open Inventor, and subclasses will need to override this method to create details for a \fBSoPickedPoint\fP\&.

.PP
This is not necessary with Coin\&. Of course, if you choose to override it, it will work in the same way as Open Inventor\&.

.PP
For this to work, you must supply a point detail in the \fBSoPrimitiveVertex\fP in \fBgeneratePrimitives()\fP\&. 
.SS "void SoShape::invokeTriangleCallbacks (\fBSoAction\fP *const action, const \fBSoPrimitiveVertex\fP *const v1, const \fBSoPrimitiveVertex\fP *const v2, const \fBSoPrimitiveVertex\fP *const v3)\fR [protected]\fP"
\fIThis API member is considered internal to the library, as it is not likely to be of interest to the application programmer\&.\fP
.br

.br

.SS "void SoShape::invokeLineSegmentCallbacks (\fBSoAction\fP *const action, const \fBSoPrimitiveVertex\fP *const v1, const \fBSoPrimitiveVertex\fP *const v2)\fR [protected]\fP"
\fIThis API member is considered internal to the library, as it is not likely to be of interest to the application programmer\&.\fP
.br

.br

.SS "void SoShape::invokePointCallbacks (\fBSoAction\fP *const action, const \fBSoPrimitiveVertex\fP *const v)\fR [protected]\fP"
\fIThis API member is considered internal to the library, as it is not likely to be of interest to the application programmer\&.\fP
.br

.br

.SS "void SoShape::beginShape (\fBSoAction\fP *const action, const \fBTriangleShape\fP shapetype, \fBSoDetail\fP *const detail = \fRNULL\fP)\fR [protected]\fP"
This method is used to generate primitives for a shape\&. It's typically called from a node's \fBgeneratePrimitives()\fP method\&. If you have your own shape and want to write a \fBgeneratePrimitives()\fP method for that shape, it's probably a good idea to take a peek in the \fBgeneratePrimitives()\fP method for a similar shape in Coin\&.

.PP
\fBgeneratePrimitives()\fP can contain several \fBbeginShape()\fP/endShape() sequences\&. \fBshapeVertex()\fP is used for each vertex between \fBbeginShape()\fP and \fBendShape()\fP\&. For instance, to generate primitives for a triangle you'd do something like this:

.PP
.PP
.nf
SoPrimitiveVertex vertex;

this->beginShape(action, SoShape::POLYGON);
vertex\&.setPoint(SbVec3f(0\&.0f, 0\&.0f, 0\&.0f));
this->shapeVertex(&vertex);
vertex\&.setPoint(SbVec3f(1\&.0f, 0\&.0f, 0\&.0f));
this->shapeVertex(&vertex);
vertex\&.setPoint(SbVec3f(1\&.0f, 1\&.0f, 0\&.0f));
this->shapeVertex(&vertex);
this->endShape();
.fi
.PP

.PP
Note that the \fBSoPrimitiveVertex\fP instance can simply be placed on the stack and not allocated\&. \fBSoShape\fP will copy the needed information when you call \fBshapeVertex()\fP\&.

.PP
Before calling \fBshapeVertex()\fP, you can set extra information for the \fBSoPrimitiveVertex\fP, including normal, material index, and texture coordinates\&.

.PP
This method is slightly different from its counterpart from the original Open Inventor library, as this method has an \fBSoDetail\fP as the last argument, and not an \fBSoFaceDetail\fP\&. This is because we accept more TriangleShape types, and the detail might be a \fBSoFaceDetail\fP or a \fBSoLineDetail\fP\&. There is no use sending in a \fBSoPointDetail\fP, as nothing will be done with it\&. 
.SS "void SoShape::shapeVertex (const \fBSoPrimitiveVertex\fP *const v)\fR [protected]\fP"
This method is used while generating primitives for a shape\&. See \fBbeginShape()\fP for more details\&.

.PP
\fBSee also\fP
.RS 4
\fBbeginShape()\fP, \fBendShape()\fP 
.RE
.PP

.SS "void SoShape::endShape (void )\fR [protected]\fP"
This method is used while generating primitives for a shape\&. See \fBbeginShape()\fP for more details\&.

.PP
\fBSee also\fP
.RS 4
\fBbeginShape()\fP, \fBshapeVertex()\fP 
.RE
.PP

.SS "void SoShape::generateVertex (\fBSoPrimitiveVertex\fP *const pv, const \fBSbVec3f\fP & point, const SbBool usetexfunc, const \fBSoMultiTextureCoordinateElement\fP *const tce, const float s, const float t, const \fBSbVec3f\fP & normal)\fR [protected]\fP"
Convenience function which sets up an \fBSoPrimitiveVertex\fP, and sends it using the \fBSoShape::shapeVertex()\fP function\&. 2D version 
.SS "void SoShape::generateVertex (\fBSoPrimitiveVertex\fP *const pv, const \fBSbVec3f\fP & point, const SbBool usetexfunc, const \fBSoMultiTextureCoordinateElement\fP *const tce, const float s, const float t, const float r, const \fBSbVec3f\fP & normal)\fR [protected]\fP"
Convenience function which sets up an \fBSoPrimitiveVertex\fP, and sends it using the \fBSoShape::shapeVertex()\fP function\&. 3D version\&.

.PP
This function is an extension for Coin, and it is not available in the original SGI Open Inventor v2\&.1 API\&.
.br
 
.PP
\fBSince\fP
.RS 4
Coin 2\&.0 
.RE
.PP

.SS "SbBool SoShape::startVertexArray (\fBSoGLRenderAction\fP * action, const \fBSoCoordinateElement\fP * coords, const \fBSbVec3f\fP * pervertexnormals, const SbBool texpervertex, const SbBool colorpervertex)\fR [protected]\fP"
Convenience method that enables vertex arrays and/or VBOs Returns \fITRUE\fP if VBO is used\&.

.PP
\fBSee also\fP
.RS 4
\fBfinishVertexArray()\fP 
.RE
.PP
\fBSince\fP
.RS 4
Coin 3\&.0 
.RE
.PP

.SS "void SoShape::finishVertexArray (\fBSoGLRenderAction\fP * action, const SbBool vbo, const SbBool normpervertex, const SbBool texpervertex, const SbBool colorpervertex)\fR [protected]\fP"
Should be called after rendering with vertex arrays\&. This method will disable arrays and VBOs enabled in the \fBstartVertexArray()\fP function\&.

.PP
\fBSee also\fP
.RS 4
\fBstartVertexArray()\fP 
.RE
.PP
\fBSince\fP
.RS 4
Coin 3\&.0 
.RE
.PP


.SH "Author"
.PP 
Generated automatically by Doxygen for Coin from the source code\&.