com.openinventor.inventor.vrmlnodes

Class SoVRMLTransform

java.lang.Object

com.openinventor.inventor.Inventor

com.openinventor.inventor.misc.SoBase

com.openinventor.inventor.fields.SoFieldContainer

com.openinventor.inventor.nodes.SoNode

com.openinventor.inventor.nodes.SoGroup

com.openinventor.inventor.vrmlnodes.SoVRMLParent

com.openinventor.inventor.vrmlnodes.SoVRMLGroup

com.openinventor.inventor.vrmlnodes.SoVRMLTransform

All Implemented Interfaces:

SafeDisposable

Deprecated.

As of Open Inventor 9500 See documentation for more details

public class SoVRMLTransform
extends SoVRMLGroup

Grouping node that defines a coordinate system for its children. A 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

Deprecated since 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.

Nested Class Summary

Nested classes/interfaces inherited from class com.openinventor.inventor.vrmlnodes.SoVRMLGroup

SoVRMLGroup.Cachings

Nested classes/interfaces inherited from class com.openinventor.inventor.Inventor

Inventor.ConstructorCommand

Field Summary

Fields

Modifier and Type	Field and Description
SoSFVec3f	center Deprecated. Origin of scale and rotation.
SoSFRotation	rotation Deprecated. Rotation.
SoSFVec3f	scale Deprecated. Scale factor.
SoSFRotation	scaleOrientation Deprecated. Rotational orientation for scale.
SoSFVec3f	translation Deprecated. Translation vector.

Fields inherited from class com.openinventor.inventor.vrmlnodes.SoVRMLGroup

AUTO, boundingBoxCaching, directVizCaching, OFF, ON, pickCulling, renderCaching, renderCulling, renderUnitId

Fields inherited from class com.openinventor.inventor.vrmlnodes.SoVRMLParent

bboxCenter, bboxSize, children, metadata

Fields inherited from class com.openinventor.inventor.nodes.SoGroup

boundingBoxIgnoring

Fields inherited from class com.openinventor.inventor.Inventor

VERBOSE_LEVEL, ZeroHandle

Constructor Summary

Constructors

Constructor and Description
SoVRMLTransform() Deprecated. Constructor.
SoVRMLTransform(int nChildren) Deprecated. Constructor that takes approximate number of children.

Method Summary

Modifier and Type	Method and Description
void	combineLeft(SoVRMLTransform nodeOnLeft) Deprecated. Same as multLeft() except that the transformation to multiply into this node comes from another transformation node.
void	combineRight(SoVRMLTransform nodeOnRight) Deprecated. Same as multRight() except that the transformation to multiply into this node comes from another transformation node.
SbMatrix[]	getRotationSpaceMatrix() Deprecated. Returns composite matrix that transforms from object space to rotation space (the space after the scale and rotation).
SbMatrix[]	getScaleSpaceMatrix() Deprecated. Returns composite matrix that transforms from object space to scale space (the space after the scale).
SbMatrix[]	getTranslationSpaceMatrix() Deprecated. Returns composite matrix that transforms from object space to translation space (the space after scale, rotation, and translation).
void	multLeft(SbMatrix mat) Deprecated. Convenience function that combines the effects of a matrix transformation into the transformation stored in this node.
void	multRight(SbMatrix mat) Deprecated. Convenience function that combines the effects of a matrix transformation into the transformation stored in this node.
void	pointAt(SbVec3f fromPoint, SbVec3f toPoint) Deprecated. 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.
void	recenter(SbVec3f newCenter) Deprecated. Changes the center of the transformation to the given point without affecting the overall effect of the transformation.
void	setMatrix(SbMatrix mat) Deprecated. Sets the fields in the node to implement the transformation represented by the given matrix.

Methods inherited from class com.openinventor.inventor.vrmlnodes.SoVRMLGroup

getNumRenderCaches, setNumRenderCaches

Methods inherited from class com.openinventor.inventor.nodes.SoGroup

addChild, findChild, getChild, getNumChildren, insertChild, removeAllChildren, removeChild, removeChild, replaceChild, replaceChild

Methods inherited from class com.openinventor.inventor.nodes.SoNode

affectsState, callback, copy, copy, distribute, doAction, getAlternateRep, getBoundingBox, getByName, getMatrix, getPrimitiveCount, getRenderUnitID, GLRender, GLRenderBelowPath, GLRenderInPath, GLRenderOffPath, grabEventsCleanup, grabEventsSetup, handleEvent, isBoundingBoxIgnoring, isOverride, pick, rayPick, search, setOverride, touch, write

Methods inherited from class com.openinventor.inventor.fields.SoFieldContainer

copyFieldValues, copyFieldValues, enableNotify, fieldsAreEqual, get, getAllFields, getEventIn, getEventOut, getField, getFieldName, hasDefaultValues, isNotifyEnabled, set, setToDefaults

Methods inherited from class com.openinventor.inventor.misc.SoBase

dispose, getEXTERNPROTO, getName, getPROTO, isDisposable, isSynchronizable, setName, setSynchronizable

Methods inherited from class com.openinventor.inventor.Inventor

getAddress, getNativeResourceHandle, startInternalThreads, stopInternalThreads

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

translation

public final SoSFVec3f translation

Deprecated.

Translation vector.

rotation

public final SoSFRotation rotation

Deprecated.

Rotation.

scale

public final SoSFVec3f scale

Deprecated.

Scale factor.

scaleOrientation

public final SoSFRotation scaleOrientation

Deprecated.

Rotational orientation for scale.

center

public final SoSFVec3f center

Deprecated.

Origin of scale and rotation.

Constructor Detail

SoVRMLTransform

public SoVRMLTransform()

Deprecated.

Constructor.

SoVRMLTransform

public SoVRMLTransform(int nChildren)

Deprecated.

Constructor that takes approximate number of children.

Method Detail

setMatrix

public void setMatrix(SbMatrix mat)

Deprecated.

Sets the fields in the node to implement the transformation represented by the given matrix.

getTranslationSpaceMatrix

public SbMatrix[] getTranslationSpaceMatrix()

Deprecated.

Returns composite matrix that transforms from object space to translation space (the space after scale, rotation, and translation).

getRotationSpaceMatrix

public SbMatrix[] getRotationSpaceMatrix()

Deprecated.

Returns composite matrix that transforms from object space to rotation space (the space after the scale and rotation).

multLeft

public void multLeft(SbMatrix mat)

Deprecated.

Convenience function that combines the effects of a matrix transformation into the transformation stored in this node. This method premultiplies the transformation.

multRight

public void multRight(SbMatrix mat)

Deprecated.

Convenience function that combines the effects of a matrix transformation into the transformation stored in this node. This method postmultiplies the transformation.

combineRight

public void combineRight(SoVRMLTransform nodeOnRight)

Deprecated.

Same as multRight() except that the transformation to multiply into this node comes from another transformation node.

combineLeft

public void combineLeft(SoVRMLTransform nodeOnLeft)

Deprecated.

Same as multLeft() except that the transformation to multiply into this node comes from another transformation node.

pointAt

public void pointAt(SbVec3f fromPoint,
                    SbVec3f toPoint)

Deprecated.

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. This always tries to keep the "up" direction the positive y-axis, unless that is impossible. All current info in the node is wiped out.

recenter

public void recenter(SbVec3f newCenter)

Deprecated.

Changes the center of the transformation to the given point without affecting the overall effect of the transformation.

getScaleSpaceMatrix

public SbMatrix[] getScaleSpaceMatrix()

Deprecated.

Returns composite matrix that transforms from object space to scale space (the space after the scale).