| SoVRMLTransform Class |
Note: This API is now obsolete.
Grouping node that defines a coordinate system for its children.
Inheritance HierarchyOIV.InventorSoNetBase
OIV.InventorSoDisposable
OIV.Inventor.MiscSoBase
OIV.Inventor.FieldsSoFieldContainer
OIV.Inventor.NodesSoNode
OIV.Inventor.NodesSoGroup
OIV.Inventor.VRMLnodesSoVRMLParent
OIV.Inventor.VRMLnodesSoVRMLGroup
OIV.Inventor.VRMLnodesSoVRMLTransform
Namespace: OIV.Inventor.VRMLnodes
Assembly: OIV.Inventor (in OIV.Inventor.dll) Version: 9.9.13.0 (9.9.13.0)
SyntaxThe SoVRMLTransform type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | SoVRMLTransform | Constructor. |
| SoVRMLTransform(Int32) | Constructor that takes approximate number of children. |
Methods| Name | Description | |
|---|---|---|
| AddChild | Adds a child as last one in group. |
| AffectsState | Returns true if a node has an effect on the state during traversal. |
| Callback | (Overrides SoVRMLGroupCallback(SoCallbackAction).) |
| CombineLeft | Same as multLeft() except that the transformation to multiply into this node comes from another transformation node. |
| CombineRight | Same as multRight() except that the transformation to multiply into this node comes from another transformation node. |
| Copy | Calls Copy(false). (Inherited from SoNode.) |
| Copy(Boolean) | Creates and returns an exact copy of the node. |
| CopyFieldValues(SoFieldContainer) | Calls CopyFieldValues(fc, false). (Inherited from SoFieldContainer.) |
| CopyFieldValues(SoFieldContainer, Boolean) | Copies the contents of fc's fields into this object's fields. |
| Dispose |
Releases all resources used by SoDisposable.
(Inherited from SoDisposable.) |
| Distribute | (Inherited from SoVRMLGroup.) |
| DoAction | (Overrides SoVRMLGroupDoAction(SoAction).) |
| EnableNotify | Notification at this Field Container is enabled (if flag == true) or disabled (if flag == false). |
| Equals | (Inherited from Object.) |
| FieldsAreEqual | Returns true if this object's fields are exactly equal to fc's fields. |
| FindChild | Finds index of given child within group. |
| Get | Returns the values of the fields of this object in the Open Inventor ASCII file format in the given string. |
| GetAllFields | Returns a list of fields, including the eventIn's and eventOut's. |
| GetAlternateRep | This method is called by actions to allow the node to provide an "alternate representation" when appropriate (typically depending on the action type). |
| GetBoundingBox | (Overrides SoVRMLGroupGetBoundingBox(SoGetBoundingBoxAction).) |
| GetChild | Returns the nth child node. |
| GetEventIn | Returns a the eventIn with the given name. |
| GetEventOut | Returns the eventOut with the given name. |
| GetField | Returns a the field of this object whose name is fieldName. |
| GetFieldName | Returns the name of the given field in the fieldName argument. |
| GetFields | Appends references to all of this object's fields to resultList, and returns the number of fields appended. |
| GetHashCode |
Overrides GetHashCode().
(Inherited from SoNetBase.) |
| GetMatrix | (Overrides SoVRMLGroupGetMatrix(SoGetMatrixAction).) |
| GetName | Returns the name of an instance. |
| GetNumChildren | Returns number of children. |
| GetPrimitiveCount | (Overrides SoVRMLGroupGetPrimitiveCount(SoGetPrimitiveCountAction).) |
| GetRenderUnitID | (Inherited from SoNode.) |
| GetRotationSpaceMatrix | Returns composite matrix that transforms from object space to rotation space (the space after the scale and rotation). |
| GetScaleSpaceMatrix | Returns composite matrix that transforms from object space to scale space (the space after the scale). |
| GetStringName | (Inherited from SoBase.) |
| GetTranslationSpaceMatrix | Returns composite matrix that transforms from object space to translation space (the space after scale, rotation, and translation). |
| GetType | Gets the Type of the current instance. (Inherited from Object.) |
| GLRender | (Inherited from SoVRMLGroup.) |
| GLRenderBelowPath | (Overrides SoVRMLGroupGLRenderBelowPath(SoGLRenderAction).) |
| GLRenderInPath | (Overrides SoVRMLGroupGLRenderInPath(SoGLRenderAction).) |
| GLRenderOffPath | (Inherited from SoVRMLGroup.) |
| GrabEventsCleanup | (Inherited from SoNode.) |
| GrabEventsSetup | (Inherited from SoNode.) |
| HandleEvent | (Inherited from SoGroup.) |
| HasDefaultValues | Returns true if all of the object's fields have their default values. |
| InsertChild | Adds a child so that it becomes the one with the given index. |
| IsBoundingBoxIgnoring | Used by BoundingBoxAction to known if bounding box computation should be ignored or not. |
| IsNotifyEnabled | Notification is the process of telling interested objects that this object has changed. |
| IsOverride | Returns the state of the override flag. |
| IsSynchronizable | Gets the ScaleViz synchronizable state of this object. |
| MultLeft | Convenience function that combines the effects of a matrix transformation into the transformation stored in this node. |
| MultRight | Convenience function that combines the effects of a matrix transformation into the transformation stored in this node. |
| Pick | (Inherited from SoGroup.) |
| PointAt | Sets the transform to translate the origin to the fromPoint and rotate the negative z-axis (0,0,-1) to lie on the vector from fromPoint to toPoint. |
| RayPick | (Overrides SoVRMLGroupRayPick(SoRayPickAction).) |
| Recenter | Changes the center of the transformation to the given point without affecting the overall effect of the transformation. |
| RemoveAllChildren | Removes all children from group. |
| RemoveChild(Int32) | Removes child with given index from group. |
| RemoveChild(SoNode) | Removes first instance of given child from group. |
| ReplaceChild(Int32, SoNode) | Replaces child with given index with new child. |
| ReplaceChild(SoNode, SoNode) | Replaces first instance of given child with new child. |
| Search | (Overrides SoVRMLGroupSearch(SoSearchAction).) |
| Set | 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. |
| SetMatrix | Sets the fields in the node to implement the transformation represented by the given matrix. |
| SetName | (Inherited from SoBase.) |
| SetOverride | Turns the override flag on or off. |
| SetSynchronizable | Sets this to be a ScaleViz synchronizable object. |
| SetToDefaults | Sets all fields in this object to their default values. |
| ToString |
Converts this SoBase structure to a human readable string.
(Inherited from SoBase.) |
| Touch | Marks an instance as modified, simulating a change to it. |
| Write | (Inherited from SoVRMLGroup.) |
Properties| Name | Description | |
|---|---|---|
 | bboxCenter | The bboxCenter and bboxSize fields specify a bounding box that encloses the SoVRMLParent's children. |
| bboxSize | The bboxCenter and bboxSize fields specify a bounding box that encloses the SoVRMLParents's children. |
| boundingBoxCaching | Whether to cache during bounding box traversal. |
| boundingBoxIgnoring | Whether to ignore this node during bounding box traversal. |
| center | Origin of scale and rotation. |
| children | Field that contains a list of children nodes. |
| directVizCaching | Whether to cache during DirectViz rendering traversal. |
| IsDisposable | ISafeDisposable interface implementation.
(Inherited from SoDisposable.) |
| metadata | Specifies the metadata node. |
| pickCulling | Whether to cull during pick traversal. |
| renderCaching | Whether to cache during rendering traversal. |
| renderCulling | Whether to cull during rendering traversal. |
| renderUnitId | Used during the ScaleViz depth compositing process, this field specifies which render unit (OIRU) will render the sub scene graph below this separator. |
| rotation | Rotation. |
| scale | Scale factor. |
| scaleOrientation | Rotational orientation for scale. |
| translation | Translation vector. |
| UserData |
Gets or sets the user data to be contained by the field container.
(Inherited from SoFieldContainer.) |
RemarksA SoVRMLTransform is a grouping node that defines a coordinate system for its children that is relative to the coordinate systems of its parents.
<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.
A SoVRMLTransform is a grouping node that defines a coordinate system for its children that is relative to the coordinate systems of its parents. See also "Concepts - Coordinate Systems and Transformations."
See the "Concepts - Grouping and Children Nodes" section for a description of the children , addChildren , and removeChildren fields and eventIns.
The bboxCenter and bboxSize fields specify a bounding box that encloses the SoVRMLTransform's children. This is a hint that may be used for optimization purposes. If the specified bounding box is smaller than the actual bounding box of the children at any time, then the results are undefined. A default bboxSize value, (-1 -1 -1), implies that the bounding box is not specified and if needed must be calculated by the browser. See "Concepts - Bounding Boxes" for a description of the bboxCenter and bboxSize fields.
The translation, rotation, scale, scaleOrientation and center fields define a geometric 3D transformation consisting of (in order) a (possibly) non-uniform scale about an arbitrary point, a rotation about an arbitrary point and axis, and a translation. The center field specifies a translation offset from the local coordinate system's origin, (0,0,0). The rotation field specifies a rotation of the coordinate system. The scale field specifies a non-uniform scale of the coordinate system - scale values must be >= 0.0. The scaleOrientation specifies a rotation of the coordinate system before the scale (to specify scales in arbitrary orientations). The scaleOrientation applies only to the scale operation. The translation field specifies a translation to the coordinate system.
Given a 3-dimensional point P and Transform node, P is transformed into point P ' in its parent's coordinate system by a series of intermediate transformations. In matrix-transformation notation, where C (center), SR (scaleOrientation), T (translation), R (rotation), and S (scale) are the equivalent transformation matrices,
P' = T x C x R x SR x S x -SR x -TC x P (where P is a column vector)The SoVRMLTransform node:
Transform {
center C
rotation R
scale S
scaleOrientation SR
translation T
children [...]
} is equivalent to the nested sequence of: Transform { translation T
Transform { translation C
Transform { rotation R
Transform { rotation SR
Transform { scale S
Transform { rotation -SR
Transform { translation -C
...
}}}}}}}FILE FORMAT/DEFAULT
VRMLTransform {
| center | 0 0 0 |
| children | [] |
| rotation | 0 0 1 0 |
| scale | 1 1 1 |
| scaleOrientation | 0 0 1 0 |
| translation | 0 0 0 |
| bboxCenter | 0 0 0 |
| bboxSize | -1 -1 -1 |
| metadata | NULL |
ACTION BEHAVIOR
SoGLRenderAction, SoCallbackAction, SoGetBoundingBoxAction, SoRayPickAction, SoGetMatrixAction, SoSearchAction, SoWriteAction Sets: SoModelMatrixElement
EVENTS
eventIn
| SoMFNode | addChildren |
| SoMFNode | removeChildren |
| SoSFVec3f | set_center |
| SoMFNode | set_children |
| SoSFRotation | set_rotation |
| SoSFVec3f | set_scale |
| SoSFRotation | set_scaleOrientation |
| SoSFVec3f | set_translation |
| SoSFNode | set_metadata |
eventOut
| SoSFVec3f | center_changed |
| SoMFNode | children_changed |
| SoSFRotation | rotation_changed |
| SoSFVec3f | scale_changed |
| SoSFRotation | scaleOrientation_changed |
| SoSFVec3f | translation_changed |
| SoSFNode | metadata_changed |
See Also