SoVRMLElevationGrid(3) Coin SoVRMLElevationGrid(3) NAME SoVRMLElevationGrid - The SoVRMLElevationGrid class is used to represent elevation grids. SYNOPSIS #include Inherits SoVRMLGeometry. Public Member Functions virtual SoType getTypeId (void) const SoVRMLElevationGrid (void) virtual void GLRender (SoGLRenderAction *action) virtual void rayPick (SoRayPickAction *action) virtual void getPrimitiveCount (SoGetPrimitiveCountAction *action) Public Member Functions inherited from SoVRMLGeometry virtual void search (SoSearchAction *action) virtual void copyContents (const SoFieldContainer *from, SbBool copyConn) Public Member Functions inherited from SoShape virtual SbBool affectsState (void) const virtual void getBoundingBox (SoGetBoundingBoxAction *action) virtual void callback (SoCallbackAction *action) const SoBoundingBoxCache * getBoundingBoxCache (void) const Public Member Functions inherited from SoNode void setOverride (const SbBool state) SbBool isOverride (void) const void setNodeType (const NodeType type) NodeType getNodeType (void) const virtual SoNode * copy (SbBool copyconnections=FALSE) const virtual void doAction (SoAction *action) virtual void GLRenderBelowPath (SoGLRenderAction *action) virtual void GLRenderInPath (SoGLRenderAction *action) virtual void GLRenderOffPath (SoGLRenderAction *action) virtual void getMatrix (SoGetMatrixAction *action) virtual void handleEvent (SoHandleEventAction *action) virtual void pick (SoPickAction *action) virtual void write (SoWriteAction *action) virtual void audioRender (SoAudioRenderAction *action) virtual void grabEventsSetup (void) virtual void grabEventsCleanup (void) virtual void startNotify (void) SbUniqueId getNodeId (void) const virtual void writeInstance (SoOutput *out) virtual SoNode * addToCopyDict (void) const virtual SoFieldContainer * copyThroughConnection (void) const Public Member Functions inherited from SoFieldContainer void setToDefaults (void) SbBool hasDefaultValues (void) const SbBool fieldsAreEqual (const SoFieldContainer *container) const void copyFieldValues (const SoFieldContainer *container, SbBool copyconnections=FALSE) SbBool set (const char *const fielddata) void get (SbString &fielddata) virtual int getFields (SoFieldList &l) const virtual int getAllFields (SoFieldList &l) const virtual SoField * getField (const SbName &name) const virtual SoField * getEventIn (const SbName &name) const virtual SoField * getEventOut (const SbName &name) const SbBool getFieldName (const SoField *const field, SbName &name) const SbBool enableNotify (const SbBool flag) SbBool isNotifyEnabled (void) const SbBool set (const char *fielddata, SoInput *input) void get (SbString &fielddata, SoOutput *out) virtual SbBool validateNewFieldValue (SoField *field, void *newval) virtual void addWriteReference (SoOutput *out, SbBool isfromfield=FALSE) SbBool getIsBuiltIn (void) const virtual void getFieldsMemorySize (size_t &managed, size_t &unmanaged) const void setUserData (void *userdata) const void * getUserData (void) const Public Member Functions inherited from SoBase void ref (void) const void unref (void) const void unrefNoDelete (void) const int32_t getRefCount (void) const void touch (void) SbBool isOfType (SoType type) const Returns TRUE if the type of this object is either of the same type or inherited from type. virtual SbName getName (void) const virtual void setName (const SbName &newname) void addAuditor (void *const auditor, const SoNotRec::Type type) void removeAuditor (void *const auditor, const SoNotRec::Type type) const SoAuditorList & getAuditors (void) const SbBool shouldWrite (void) void assertAlive (void) const Static Public Member Functions static SoType getClassTypeId (void) static void initClass (void) Static Public Member Functions inherited from SoVRMLGeometry static SoType getClassTypeId (void) static void initClass (void) Static Public Member Functions inherited from SoShape static SoType getClassTypeId (void) static void initClass (void) Sets up initialization for data common to all instances of this class, like submitting necessary information to the Coin type system. static void getScreenSize (SoState *const state, const SbBox3f &boundingbox, SbVec2s &rectsize) static float getDecimatedComplexity (SoState *state, float complexity) Static Public Member Functions inherited from SoNode static uint32_t getCompatibilityTypes (const SoType &nodetype) static SoType getClassTypeId (void) static SoNode * getByName (const SbName &name) static int getByName (const SbName &name, SoNodeList &l) static void initClass (void) Sets up initialization for data common to all instances of this class, like submitting necessary information to the Coin type system. static void initClasses (void) static SbUniqueId getNextNodeId (void) static int getActionMethodIndex (const SoType type) static void getBoundingBoxS (SoAction *action, SoNode *node) static void GLRenderS (SoAction *action, SoNode *node) static void callbackS (SoAction *action, SoNode *node) static void getMatrixS (SoAction *action, SoNode *node) static void handleEventS (SoAction *action, SoNode *node) static void pickS (SoAction *action, SoNode *node) static void rayPickS (SoAction *action, SoNode *node) static void searchS (SoAction *action, SoNode *node) static void writeS (SoAction *action, SoNode *node) static void audioRenderS (SoAction *action, SoNode *node) static void getPrimitiveCountS (SoAction *action, SoNode *node) Static Public Member Functions inherited from SoFieldContainer static void initClass (void) Sets up initialization for data common to all instances of this class, like submitting necessary information to the Coin type system. static SoType getClassTypeId (void) This static method returns the SoType object associated with objects of this class. static void cleanupClass (void) static void initCopyDict (void) static void addCopy (const SoFieldContainer *orig, const SoFieldContainer *copy) static SoFieldContainer * checkCopy (const SoFieldContainer *orig) static SoFieldContainer * findCopy (const SoFieldContainer *orig, const SbBool copyconnections) static void copyDone (void) Static Public Member Functions inherited from SoBase static void initClass (void) Sets up initialization for data common to all instances of this class, like submitting necessary information to the Coin type system. static SoType getClassTypeId (void) This static method returns the SoType object associated with objects of this class. static void addName (SoBase *const base, const char *const name) static void removeName (SoBase *const base, const char *const name) static void incrementCurrentWriteCounter (void) static void decrementCurrentWriteCounter (void) static SoBase * getNamedBase (const SbName &name, SoType type) static int getNamedBases (const SbName &name, SoBaseList &baselist, SoType type) static SbBool read (SoInput *input, SoBase *&base, SoType expectedtype) static void setInstancePrefix (const SbString &c) static void setTraceRefs (SbBool trace) static SbBool getTraceRefs (void) static SbBool connectRoute (SoInput *input, const SbName &fromnodename, const SbName &fromfieldname, const SbName &tonodename, const SbName &tofieldname) static SbBool readRoute (SoInput *input) Public Attributes SoSFBool ccw SoSFBool solid SoSFFloat creaseAngle SoSFInt32 zDimension SoSFInt32 xDimension SoSFFloat zSpacing SoSFFloat xSpacing SoMFFloat height SoSFNode texCoord SoSFNode normal SoSFNode color SoSFBool colorPerVertex SoSFBool normalPerVertex Protected Member Functions virtual const SoFieldData * getFieldData (void) const virtual ~SoVRMLElevationGrid (void) virtual void notify (SoNotList *list) virtual void generatePrimitives (SoAction *action) virtual void computeBBox (SoAction *action, SbBox3f &bbox, SbVec3f ¢er) Protected Member Functions inherited from SoVRMLGeometry SoVRMLGeometry (void) virtual ~SoVRMLGeometry () void setupShapeHints (SoState *state, const SbBool ccw, const SbBool solid) virtual SbBool shouldGLRender (SoGLRenderAction *action) virtual SoChildList * getChildren (void) const Protected Member Functions inherited from SoShape SoShape (void) virtual ~SoShape () float getComplexityValue (SoAction *action) void beginSolidShape (SoGLRenderAction *action) void endSolidShape (SoGLRenderAction *action) void GLRenderBoundingBox (SoGLRenderAction *action) SbBool shouldPrimitiveCount (SoGetPrimitiveCountAction *action) SbBool shouldRayPick (SoRayPickAction *const action) void computeObjectSpaceRay (SoRayPickAction *const action) void computeObjectSpaceRay (SoRayPickAction *const action, const SbMatrix &matrix) virtual SoDetail * createTriangleDetail (SoRayPickAction *action, const SoPrimitiveVertex *v1, const SoPrimitiveVertex *v2, const SoPrimitiveVertex *v3, SoPickedPoint *pp) virtual SoDetail * createLineSegmentDetail (SoRayPickAction *action, const SoPrimitiveVertex *v1, const SoPrimitiveVertex *v2, SoPickedPoint *pp) virtual SoDetail * createPointDetail (SoRayPickAction *action, const SoPrimitiveVertex *v, SoPickedPoint *pp) void invokeTriangleCallbacks (SoAction *const action, const SoPrimitiveVertex *const v1, const SoPrimitiveVertex *const v2, const SoPrimitiveVertex *const v3) void invokeLineSegmentCallbacks (SoAction *const action, const SoPrimitiveVertex *const v1, const SoPrimitiveVertex *const v2) void invokePointCallbacks (SoAction *const action, const SoPrimitiveVertex *const v) void beginShape (SoAction *const action, const TriangleShape shapetype, SoDetail *const detail=NULL) void shapeVertex (const SoPrimitiveVertex *const v) void endShape (void) void generateVertex (SoPrimitiveVertex *const pv, const SbVec3f &point, const SbBool useTexFunc, const SoMultiTextureCoordinateElement *const tce, const float s, const float t, const SbVec3f &normal) void generateVertex (SoPrimitiveVertex *const pv, const SbVec3f &point, const SbBool useTexFunc, const SoMultiTextureCoordinateElement *const tce, const float s, const float t, const float r, const SbVec3f &normal) SbBool startVertexArray (SoGLRenderAction *action, const SoCoordinateElement *coords, const SbVec3f *pervertexnormals, const SbBool texpervertex, const SbBool colorpervertex) void finishVertexArray (SoGLRenderAction *action, const SbBool vbo, const SbBool normpervertex, const SbBool texpervertex, const SbBool colorpervertex) Protected Member Functions inherited from SoNode SoNode (void) virtual ~SoNode () virtual SbBool readInstance (SoInput *in, unsigned short flags) Protected Member Functions inherited from SoFieldContainer SoFieldContainer (void) virtual ~SoFieldContainer () Protected Member Functions inherited from SoBase SoBase (void) virtual ~SoBase () virtual void destroy (void) SbBool hasMultipleWriteRefs (void) const SbBool writeHeader (SoOutput *out, SbBool isgroup, SbBool isengine) const void writeFooter (SoOutput *out) const virtual const char * getFileFormatName (void) const virtual SoNotRec createNotRec (void) Static Protected Member Functions static const SoFieldData ** getFieldDataPtr (void) Static Protected Member Functions inherited from SoVRMLGeometry static const SoFieldData ** getFieldDataPtr (void) Static Protected Member Functions inherited from SoShape static const SoFieldData ** getFieldDataPtr (void) Static Protected Member Functions inherited from SoNode static const SoFieldData ** getFieldDataPtr (void) static void setNextActionMethodIndex (int index) static int getNextActionMethodIndex (void) static void incNextActionMethodIndex (void) static void setCompatibilityTypes (const SoType &nodetype, const uint32_t bitmask) Static Protected Member Functions inherited from SoBase static uint32_t getCurrentWriteCounter (void) static void staticDataLock (void) static void staticDataUnlock (void) Additional Inherited Members Public Types inherited from SoShape enum TriangleShape { TRIANGLE_STRIP, TRIANGLE_FAN, TRIANGLES, POLYGON, QUADS, QUAD_STRIP, POINTS, LINES, LINE_STRIP } Public Types inherited from SoNode enum NodeType { INVENTOR = 0x0000, VRML1 = 0x0001, VRML2 = 0x0002, INVENTOR_1 = 0x0004, INVENTOR_2_0 = 0x0008, INVENTOR_2_1 = 0x0010, INVENTOR_2_5 = 0x0020, INVENTOR_2_6 = 0x0040, COIN_1_0 = 0x0080, COIN_2_0 = 0x0100, EXTENSION = 0x0200, COIN_2_2 = 0x0400, COIN_2_3 = 0x0800, COIN_2_4 = 0x1000, INVENTOR_5_0 = 0x2000, COIN_2_5 = 0x4000, COIN_3_0 = 0x8000, INVENTOR_6_0 = 0x10000, COIN_4_0 = 0x20000 } Protected Types inherited from SoBase enum BaseFlags { IS_ENGINE = 0x01, IS_GROUP = 0x02 } Protected Attributes inherited from SoNode SbUniqueId uniqueId Protected Attributes inherited from SoFieldContainer SbBool isBuiltIn Static Protected Attributes inherited from SoNode static SbUniqueId nextUniqueId = 1 static int nextActionMethodIndex = 0 Detailed Description The SoVRMLElevationGrid class is used to represent elevation grids. The detailed class documentation is taken verbatim from the VRML97 standard (ISO/IEC 14772-1:1997). It is copyright The Web3D Consortium, and is used by permission of the Consortium: ElevationGrid { eventIn MFFloat set_height exposedField SFNode color NULL exposedField SFNode normal NULL exposedField SFNode texCoord NULL field MFFloat height [] # (-inf,inf) field SFBool ccw TRUE field SFBool colorPerVertex TRUE field SFFloat creaseAngle 0 # [0,inf] field SFBool normalPerVertex TRUE field SFBool solid TRUE field SFInt32 xDimension 0 # [0,inf) field SFFloat xSpacing 1.0 # (0,inf) field SFInt32 zDimension 0 # [0,inf) field SFFloat zSpacing 1.0 # (0,inf) } The ElevationGrid node specifies a uniform rectangular grid of varying height in the Y=0 plane of the local coordinate system. The geometry is described by a scalar array of height values that specify the height of a surface above each point of the grid. The xDimension and zDimension fields indicate the number of elements of the grid height array in the X and Z directions. Both xDimension and zDimension shall be greater than or equal to zero. If either the xDimension or the zDimension is less than two, the ElevationGrid contains no quadrilaterals. The vertex locations for the rectangles are defined by the height field and the xSpacing and zSpacing fields: o The height field is an xDimension by zDimension array of scalar values representing the height above the grid for each vertex. o The xSpacing and zSpacing fields indicate the distance between vertices in the X and Z directions respectively, and shall be greater than zero. Thus, the vertex corresponding to the point P[i, j] on the grid is placed at: P[i,j].x = xSpacing x i P[i,j].y = height[ i + j x xDimension] P[i,j].z = zSpacing x j where 0 <= i < xDimension and 0 <= j < zDimension, and P[0,0] is height[0] units above/below the origin of the local coordinate system The set_height eventIn allows the height MFFloat field to be changed to support animated ElevationGrid nodes. The color field specifies per-vertex or per-quadrilateral colours for the ElevationGrid node depending on the value of colorPerVertex. If the color field is NULL, the ElevationGrid node is rendered with the overall attributes of the Shape node enclosing the ElevationGrid node (see 4.14, Lighting model). The colorPerVertex field determines whether colours specified in the color field are applied to each vertex or each quadrilateral of the ElevationGrid node. If colorPerVertex is FALSE and the color field is not NULL, the color field shall specify a Color node containing at least (xDimension-1)x(zDimension-1) colours; one for each quadrilateral, ordered as follows: QuadColor[i,j] = Color[ i + j x (xDimension-1)] where 0 <= i < xDimension-1 and 0 <= j < zDimension-1, and QuadColor[i,j] is the colour for the quadrilateral defined by height[i+jxxDimension], height[(i+1)+jxxDimension], height[(i+1)+(j+1)xxDimension] and height[i+(j+1)xxDimension] If colorPerVertex is TRUE and the color field is not NULL, the color field shall specify a Color node containing at least xDimension x zDimension colours, one for each vertex, ordered as follows: VertexColor[i,j] = Color[ i + j x xDimension] where 0 <= i < xDimension and 0 <= j < zDimension, and VertexColor[i,j] is the colour for the vertex defined by height[i+jxxDimension] The normal field specifies per-vertex or per-quadrilateral normals for the ElevationGrid node. If the normal field is NULL, the browser shall automatically generate normals, using the creaseAngle field to determine if and how normals are smoothed across the surface (see 4.6.3.5, Crease angle field). The normalPerVertex field determines whether normals are applied to each vertex or each quadrilateral of the ElevationGrid node depending on the value of normalPerVertex. If normalPerVertex is FALSE and the normal node is not NULL, the normal field shall specify a Normal node containing at least (xDimension-1)x(zDimension-1) normals; one for each quadrilateral, ordered as follows: QuadNormal[i,j] = Normal[ i + j x (xDimension-1)] where 0 <= i < xDimension-1 and 0 <= j < zDimension-1, and QuadNormal[i,j] is the normal for the quadrilateral defined by height[i+jxxDimension], height[(i+1)+jxxDimension], height[(i+1)+(j+1)xxDimension] and height[i+(j+1)xxDimension] If normalPerVertex is TRUE and the normal field is not NULL, the normal field shall specify a Normal node containing at least xDimension x zDimension normals; one for each vertex, ordered as follows: VertexNormal[i,j] = Normal[ i + j x xDimension] where 0 <= i < xDimension and 0 <= j < zDimension, and VertexNormal[i,j] is the normal for the vertex defined by height[i+jxxDimension] The texCoord field specifies per-vertex texture coordinates for the ElevationGrid node. If texCoord is NULL, default texture coordinates are applied to the geometry. The default texture coordinates range from (0,0) at the first vertex to (1,1) at the last vertex. The S texture coordinate is aligned with the positive X-axis, and the T texture coordinate with positive Z-axis. If texCoord is not NULL, it shall specify a TextureCoordinate node containing at least (xDimension)x(zDimension) texture coordinates; one for each vertex, ordered as follows: VertexTexCoord[i,j] = TextureCoordinate[ i + j x xDimension] where 0 <= i < xDimension and 0 <= j < zDimension, and VertexTexCoord[i,j] is the texture coordinate for the vertex defined by height[i+jxxDimension] The ccw, solid, and creaseAngle fields are described in 4.6.3, Shapes and geometry. By default, the quadrilaterals are defined with a counterclockwise ordering. Hence, the Y-component of the normal is positive. Setting the ccw field to FALSE reverses the normal direction. Backface culling is enabled when the solid field is TRUE. See Figure 6.5 for a depiction of the ElevationGrid node. Figure 6.5 Constructor & Destructor Documentation SoVRMLElevationGrid::SoVRMLElevationGrid (void) Constructor. SoVRMLElevationGrid::~SoVRMLElevationGrid (void) [protected], [virtual] Destructor. Member Function Documentation SoType SoVRMLElevationGrid::getClassTypeId (void) [static] This static method returns the SoType object associated with objects of this class. SoType SoVRMLElevationGrid::getTypeId (void) const [virtual] Returns the type identification of an object derived from a class inheriting SoBase. This is used for runtime type checking and 'downward' casting. Reimplemented from SoVRMLGeometry. const SoFieldData ** SoVRMLElevationGrid::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. Returns the SoFieldData class which holds information about fields in this node. const SoFieldData * SoVRMLElevationGrid::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. void SoVRMLElevationGrid::initClass (void) [static] void SoVRMLElevationGrid::GLRender (SoGLRenderAction * action) [virtual] Action method for the SoGLRenderAction. 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. Reimplemented from SoShape. void SoVRMLElevationGrid::rayPick (SoRayPickAction * action) [virtual] Calculates picked point based on primitives generated by subclasses. Reimplemented from SoShape. void SoVRMLElevationGrid::getPrimitiveCount (SoGetPrimitiveCountAction * action) [virtual] Action method for the SoGetPrimitiveCountAction. Calculates the number of triangle, line segment and point primitives for the node and adds these to the counters of the action. Nodes influencing how geometry nodes calculate their primitive count also override this method to change the relevant state variables. Reimplemented from SoShape. void SoVRMLElevationGrid::notify (SoNotList * l) [protected], [virtual] Notifies all auditors for this instance when changes are made. Reimplemented from SoVRMLGeometry. void SoVRMLElevationGrid::generatePrimitives (SoAction * action) [protected], [virtual] The method implements action behavior for shape nodes for SoCallbackAction. It is invoked from SoShape::callback(). (Subclasses should not override SoNode::callback().) The subclass implementations uses the convenience methods SoShape::beginShape(), SoShape::shapeVertex(), and SoShape::endShape(), with SoDetail instances, to pass the primitives making up the shape back to the caller. Implements SoShape. void SoVRMLElevationGrid::computeBBox (SoAction * action, SbBox3f & box, SbVec3f & center) [protected], [virtual] Implemented by SoShape subclasses to let the SoShape superclass know the exact size and weighted center point of the shape's bounding box. The bounding box and center point should be calculated and returned in the local coordinate system. The method implements action behavior for shape nodes for SoGetBoundingBoxAction. It is invoked from SoShape::getBoundingBox(). (Subclasses should not override SoNode::getBoundingBox().) The box parameter sent in is guaranteed to be an empty box, while center is undefined upon function entry. Implements SoShape. Member Data Documentation SoSFBool SoVRMLElevationGrid::ccw Specifies whether generated triangles are counterclockwise. Default value is TRUE. SoSFBool SoVRMLElevationGrid::solid Specifies whether backface culling should be done. Default value is TRUE. SoSFFloat SoVRMLElevationGrid::creaseAngle Specifies the normal calculation crease angle. SoSFInt32 SoVRMLElevationGrid::zDimension Specifies the number of points in the z dimension. SoSFInt32 SoVRMLElevationGrid::xDimension Specifies the number of points in the x dimension. SoSFFloat SoVRMLElevationGrid::zSpacing Specifies the spacing between points in the z dimension. Default value is 1.0. SoSFFloat SoVRMLElevationGrid::xSpacing Specifies the spacing between points in the x dimension. Default value is 1.0. SoMFFloat SoVRMLElevationGrid::height Contains the array of height values. SoSFNode SoVRMLElevationGrid::texCoord Can contain an SoVRMLTextureCoordinate node containing one texture coordinate per grid point. SoSFNode SoVRMLElevationGrid::normal Can contain an SoVRMLTextureCoordinate node containing normals for the grid. SoSFNode SoVRMLElevationGrid::color Can contain an SoVRMLColor node containing grid colors. SoSFBool SoVRMLElevationGrid::colorPerVertex Specifies whether colors should be applied per vertex. Default value is TRUE. SoSFBool SoVRMLElevationGrid::normalPerVertex Specifies whether normals should be applied per vertex. Default value is TRUE. Author Generated automatically by Doxygen for Coin from the source code. Version 4.0.2 Tue Dec 26 2023 17:59:22 SoVRMLElevationGrid(3)