Click or drag to resize
SoVRMLElevationGrid Class

Note: This API is now obsolete.

Specifies a uniform rectangular grid of varying height in the XZ plane.

Inheritance Hierarchy

Namespace: OIV.Inventor.VRMLnodes
Assembly: OIV.Inventor (in OIV.Inventor.dll) Version: 9.9.13.0 (9.9.13.0)
Syntax
[ObsoleteAttribute("See documentation for more details")]
[EditorBrowsableAttribute(EditorBrowsableState.Never)]
public class SoVRMLElevationGrid : SoVRMLGridShape

The SoVRMLElevationGrid type exposes the following members.

Constructors
  NameDescription
Public methodSoVRMLElevationGrid

Constructor.

Top
Methods
  NameDescription
Public methodAffectsState

Overrides default method on SoNode.

(Inherited from SoShape.)
Public methodBeginShape(SoAction, SoShapeTriangleShapes)
Calls BeginShape(action, shapeType, (OIV.Inventor.Details.SoFaceDetail ^)nullptr).
(Inherited from SoShape.)
Public methodBeginShape(SoAction, SoShapeTriangleShapes, SoFaceDetail)

These methods can be used by subclasses to generate triangles more easily when those triangles are part of a larger structure, such as a triangle strip, triangle fan, or triangulated polygon, according to the TriangleShape enumerated type.

(Inherited from SoShape.)
Public methodCallback

Implements primitive generation for all shapes.

(Inherited from SoShape.)
Public methodCallShouldGLRender Obsolete.
Calls CallShouldGLRender(action, false).
(Inherited from SoShape.)
Public methodComputeBBox(SoAction, SbXfBox3d, SbVec3d)

Compute object oriented bounding box (OOB) for subclass using information in the given action (which may not necessarily be an SoGetBoundingBoxAction).

(Inherited from SoShape.)
Public methodComputeBBox(SoAction, SbBox3f, SbVec3f)

Compute axis aligned bounding box (AABB) for subclass using information in the given action (which may not necessarily be an SoGetBoundingBoxAction).

(Overrides SoShapeComputeBBox(SoAction, SbBox3f, SbVec3f).)
Public methodCopy
Calls Copy(false).
(Inherited from SoNode.)
Public methodCopy(Boolean)

Creates and returns an exact copy of the node.

(Inherited from SoNode.)
Public methodCopyFieldValues(SoFieldContainer)
Calls CopyFieldValues(fc, false).
(Inherited from SoFieldContainer.)
Public methodCopyFieldValues(SoFieldContainer, Boolean)

Copies the contents of fc's fields into this object's fields.

(Inherited from SoFieldContainer.)
Public methodDispose
Releases all resources used by SoDisposable.
(Inherited from SoDisposable.)
Public methodDistribute
(Inherited from SoNode.)
Public methodDoAction
(Inherited from SoNode.)
Public methodEnableNotify

Notification at this Field Container is enabled (if flag == true) or disabled (if flag == false).

(Inherited from SoFieldContainer.)
Public methodEndShape

end shape previously started with beginShape().

(Inherited from SoShape.)
Public methodEquals
Determines whether the specified Object is equal to the current Object.
(Inherited from Object.)
Public methodFieldsAreEqual

Returns true if this object's fields are exactly equal to fc's fields.

(Inherited from SoFieldContainer.)
Public methodGeneratePick
Public methodGet

Returns the values of the fields of this object in the Open Inventor ASCII file format in the given string.

(Inherited from SoFieldContainer.)
Public methodGetAllFields

Returns a list of fields, including the eventIn's and eventOut's.

(Inherited from SoFieldContainer.)
Public methodGetAlternateRep

This method is called by actions to allow the node to provide an "alternate representation" when appropriate (typically depending on the action type).

(Inherited from SoNode.)
Public methodGetBoundingBox

Implements bounding box method using virtual computeBBox() method.

(Inherited from SoShape.)
Public methodGetEventIn

Returns a the eventIn with the given name.

(Inherited from SoFieldContainer.)
Public methodGetEventOut

Returns the eventOut with the given name.

(Inherited from SoFieldContainer.)
Public methodGetField

Returns a the field of this object whose name is fieldName.

(Inherited from SoFieldContainer.)
Public methodGetFieldName

Returns the name of the given field in the fieldName argument.

(Inherited from SoFieldContainer.)
Public methodGetFields

Appends references to all of this object's fields to resultList, and returns the number of fields appended.

(Inherited from SoFieldContainer.)
Public methodGetHashCode
Overrides GetHashCode().
(Inherited from SoNetBase.)
Public methodGetMatrix
(Inherited from SoNode.)
Public methodGetName

Returns the name of an instance.

(Inherited from SoBase.)
Public methodGetPrimitiveCount

Counts number of primitives produced by this shape.

(Overrides SoShapeGetPrimitiveCount(SoGetPrimitiveCountAction).)
Public methodGetRenderUnitID
(Inherited from SoNode.)
Public methodGetShapeType

Gets the current shape Full Scene Antialiasing type.

(Inherited from SoShape.)
Public methodGetStringName (Inherited from SoBase.)
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Public methodGLRender

Implements rendering by rendering each primitive generated by subclass.

(Overrides SoShapeGLRender(SoGLRenderAction).)
Public methodGLRenderBelowPath
(Inherited from SoNode.)
Public methodGLRenderInPath
(Inherited from SoNode.)
Public methodGLRenderOffPath
(Inherited from SoNode.)
Public methodGrabEventsCleanup
(Inherited from SoNode.)
Public methodGrabEventsSetup
(Inherited from SoNode.)
Public methodHandleEvent
(Inherited from SoNode.)
Public methodHandleInvisibleOrBBox Obsolete.
Calls HandleInvisibleOrBBox(action, false).
(Inherited from SoShape.)
Public methodHasDefaultValues

Returns true if all of the object's fields have their default values.

(Inherited from SoFieldContainer.)
Public methodIsBoundingBoxIgnoring

This method is used by getBoundingBox action traversal to know if the current node must be traversed or not, ie the bounding should be ignored.

(Inherited from SoNode.)
Public methodIsNotifyEnabled

Notification is the process of telling interested objects that this object has changed.

(Inherited from SoFieldContainer.)
Public methodIsOverride

Returns the state of the override flag.

(Inherited from SoNode.)
Public methodIsSynchronizable

Gets the ScaleViz synchronizable state of this object.

(Inherited from SoBase.)
Public methodIsTransparent
(Inherited from SoVRMLGeometry.)
Public methodPick
(Inherited from SoNode.)
Public methodRayPick

Implements picking along a ray by intersecting the ray with each primitive generated by subclass.

(Inherited from SoShape.)
Public methodSearch
(Inherited from SoNode.)
Public methodSet

Sets one or more fields in this object to the values specified in the given string, which should be a string in the Open Inventor file format.

(Inherited from SoFieldContainer.)
Public methodSetName (Inherited from SoBase.)
Public methodSetOverride

Turns the override flag on or off.

(Inherited from SoNode.)
Public methodSetShapeType

set the antialiasing type for this shape.

(Inherited from SoShape.)
Public methodSetSynchronizable

Sets this to be a ScaleViz synchronizable object.

(Inherited from SoBase.)
Public methodSetToDefaults

Sets all fields in this object to their default values.

(Inherited from SoFieldContainer.)
Public methodShapeVertex

add a primitive vertex to the shape prevously started with beginShape().

(Inherited from SoShape.)
Public methodShouldGLRender Obsolete.
Calls ShouldGLRender(action, false).
(Inherited from SoVRMLGeometry.)
Public methodShouldGLRenderCore(SoGLRenderAction) Obsolete.
Calls ShouldGLRenderCore(action, false, false).
(Inherited from SoShape.)
Public methodShouldGLRenderCore(SoGLRenderAction, Boolean) Obsolete.
Calls ShouldGLRenderCore(action, isPointsOrLines, false).
(Inherited from SoShape.)
Public methodToString
Converts this SoBase structure to a human readable string.
(Inherited from SoBase.)
Public methodTouch

Marks an instance as modified, simulating a change to it.

(Inherited from SoNode.)
Public methodWrite
(Inherited from SoNode.)
Top
Properties
  NameDescription
Public propertyboundingBoxIgnoring

Whether to ignore this node during bounding box traversal.

(Inherited from SoShape.)
Public propertyccw

Indicates whether the vertices are ordered in a counterclockwise direction when viewed from the outside (true) or in a clockwise direction (false).

Public propertycolor

An SoVRMLColor node whose colors are applied to the vertices or faces of the ElevationGrid.

(Inherited from SoVRMLGridShape.)
Public propertycolorPerVertex

If true, colors are applied to the vertices of the ElevationGrid.

(Inherited from SoVRMLGridShape.)
Public propertycreaseAngle

Indicates the minimum angle (in radians) between two adjacent face normals required to form a sharp crease at the edge when default normals are computed and used.

Public propertyheight

xDimension by zDimension array of scale factors representing the height above the grid for each vertex.

(Inherited from SoVRMLGridShape.)
Public propertyIsDisposable
ISafeDisposable interface implementation.
(Inherited from SoDisposable.)
Public propertymetadata

Specifies the metadata node.

(Inherited from SoVRMLGeometry.)
Public propertynormal

An SoVRMLNormalNode containing the normals.

(Inherited from SoVRMLGridShape.)
Public propertynormalPerVertex

If true, normals are applied to the vertices of the ElevationGrid.

(Inherited from SoVRMLGridShape.)
Public propertysolid

If you know that the shape encloses a volume, set this value to true.

Public propertytexCoord (Inherited from SoVRMLGridShape.)
Public propertyUserData
Gets or sets the user data to be contained by the field container.
(Inherited from SoFieldContainer.)
Public propertyxDimension

Number of divisions of the grid in the X direction.

(Inherited from SoVRMLGridShape.)
Public propertyxSpacing

Distance between the vertices in the X direction.

(Inherited from SoVRMLGridShape.)
Public propertyzDimension

Number of divisions of the grid in the Z direction.

(Inherited from SoVRMLGridShape.)
Public propertyzSpacing

Distance between the vertices in the Z direction.

(Inherited from SoVRMLGridShape.)
Top
Remarks

See the VRML97 Specification, below.

<font color="#0000FF">NOTE:</font> This class does not exist in Open Inventor 10.0 and later.

VRML97 SPECIFICATION

This section describes the expected behavior of the node in a conforming VRML97 browser application. In some cases, the application is responsible for implementing portions of the expected behavior. Open Inventor viewer classes and IVF classes implement some of the application behaviors.

This section may reference portions of the VRML97 specification that are not present in this help file. The complete VRML97 spec is available at http://www.web3d.org.

The SoVRMLElevationGrid node specifies a uniform rectangular grid of varying height in the XZ plane of the local coordinate system. The geometry is described by a scalar array of height values that specify the height of a rectangular surface above each point of the grid.

The xDimension and zDimension fields indicate the number of divisions of the grid height array in the X and Z directions. Both xDimension and zDimension must be > 1. The vertex locations for the rectangles are defined by the height field and the xSpacing and zSpacing fields:

  • The height field is an xDimension by zDimension array of scalar values representing the height above the grid for each vertex the height values are stored in row major order.

  • The xSpacing and zSpacing fields indicates the distance between vertices in the X and Z directions respectively, and must be >= 0.

Thus, the vertex corresponding to the point, P[ i, j], on the grid is placed at:

   P[i,j].x = @I xSpacing @i * i
  P[i,j].y = @I height @i[ i + j * @I zDimension @i]
  P[i,j].z = @I zSpacing @i * j
where 0<i< xDimension and 0<j< zDimension .

The set_height eventIn allows the height MFFloat field to be changed to allow animated SoVRMLElevationGrids.

The default texture coordinates range from [0,0] at the first vertex to [1,1] at the last vertex. The S texture coordinate will be aligned with X, and the T texture coordinate with Z.

The colorPerVertex field determines whether colors (if specified in the color field) should be applied to each vertex or each quadrilateral of the SoVRMLElevationGrid. If colorPerVertex is false and the color field is not NULL, then the color field must contain a Color node containing at least ( xDimension-1) *( zDimension-1) colors. If colorPerVertex is true and the color field is not NULL, then the color field must contain a Color node containing at least xDimension * zDimension colors.

See the "Concepts - Geometry" for a description of the ccw, solid, and creaseAngle fields.

By default, the rectangles are defined with a counterclockwise ordering, so the Y component of the normal is positive. Setting the ccw field to false reverses the normal direction. Backface culling is enabled when the ccw field and the solid field are both true (the default).

NOTE: An elevation grid may not render or pick correctly if any of its polygons are self-intersecting or non-planar.

FILE FORMAT/DEFAULT

VRMLElevationGrid {
color NULL
normal NULL
texCoord NULL
height []
ccw true
colorPerVertex true
creaseAngle 0
normalPerVertex true
solid true
xDimension 0
xSpacing 0.0
zDimension 0
zSpacing 0.0
metadata NULL
}

ACTION BEHAVIOR

SoGLRenderAction, SoRayPickAction, SoGetBoundingBoxAction, SoCallbackAction

EVENTS

eventIn

SoMFFloatset_height
SoSFNodeset_color
SoSFNodeset_normal
SoSFNodeset_texCoord
SoSFNodeset_metadata

eventOut

SoSFNodecolor_changed
SoSFNodenormal_changed
SoSFNodetexCoord_changed
SoSFNodemetadata_changed
Obsoletesince Open Inventor 9500 The VRML API is no longer supported. See section http://oivdoc95.vsg3d.com/content/compatibility-notes-4#Deprecation of the Reference Manual.

See Also