Provided by: libcoin80-doc_3.1.4~abc9f50-4ubuntu2_all

**NAME**

SoVRMLTransform - TheSoVRMLTransformclass is a grouping node that defines a transformation for its children.ThedetailedclassdocumentationistakenverbatimfromtheVRML97standard(ISO/IEC14772-1:1997).ItiscopyrightTheWeb3DConsortium,andisusedbypermissionoftheConsortium:

**SYNOPSIS**

#include <Inventor/VRMLnodes/SoVRMLTransform.h> InheritsSoVRMLGroup.PublicMemberFunctionsvirtualSoTypegetTypeId(void) constReturnsthetypeidentificationofanobjectderivedfromaclassinheritingSoBase.Thisisusedforrun-timetypecheckingand'downward'casting.SoVRMLTransform(void)SoVRMLTransform(intchildren) voidpointAt(constSbVec3f&from, constSbVec3f&to) voidgetScaleSpaceMatrix(SbMatrix&matrix,SbMatrix&inverse) const voidgetRotationSpaceMatrix(SbMatrix&matrix,SbMatrix&inverse) const voidgetTranslationSpaceMatrix(SbMatrix&matrix,SbMatrix&inverse) const voidmultLeft(constSbMatrix&matrix) voidmultRight(constSbMatrix&matrix) voidcombineLeft(SoVRMLTransform*leftnode) voidcombineRight(SoVRMLTransform*rightnode) voidsetMatrix(constSbMatrix&matrix) voidrecenter(constSbVec3f&newcenter) virtual voiddoAction(SoAction*action) virtual voidcallback(SoCallbackAction*action) virtual voidgetBoundingBox(SoGetBoundingBoxAction*action) virtual voidgetMatrix(SoGetMatrixAction*action) virtual voidrayPick(SoRayPickAction*action) virtual voidgetPrimitiveCount(SoGetPrimitiveCountAction*action) virtual voidaudioRender(SoAudioRenderAction*action) virtual voidGLRenderBelowPath(SoGLRenderAction*action) virtual voidGLRenderInPath(SoGLRenderAction*action) virtual voidnotify(SoNotList*list)StaticPublicMemberFunctionsstaticSoTypegetClassTypeId(void) static voidinitClass(void)PublicAttributesSoSFVec3ftranslationSoSFRotationrotationSoSFVec3fscaleSoSFRotationscaleOrientationSoSFVec3fcenterProtectedMemberFunctionsvirtual constSoFieldData*getFieldData(void) const virtual~SoVRMLTransform()StaticProtectedMemberFunctionsstatic constSoFieldData**getFieldDataPtr(void)AdditionalInheritedMembers

**Detailed** **Description**

TheSoVRMLTransformclass is a grouping node that defines a transformation for its children.ThedetailedclassdocumentationistakenverbatimfromtheVRML97standard(ISO/IEC14772-1:1997).ItiscopyrightTheWeb3DConsortium,andisusedbypermissionoftheConsortium:Transform { eventIn MFNode addChildren eventIn MFNode removeChildren exposedField SFVec3f center 0 0 0 # (-inf,inf) exposedField MFNode children [] exposedField SFRotation rotation 0 0 1 0 # [-1,1],(-inf,inf) exposedField SFVec3f scale 1 1 1 # (0,inf) exposedField SFRotation scaleOrientation 0 0 1 0 # [-1,1],(-inf,inf) exposedField SFVec3f translation 0 0 0 # (-inf,inf) field SFVec3f bboxCenter 0 0 0 # (-inf,inf) field SFVec3f bboxSize -1 -1 -1 # (0,inf) or -1,-1,-1 } The Transform node is a grouping node that defines a coordinate system for its children that is relative to the coordinate systems of its ancestors. See 4.4.4, Transformation hierarchy (http://www.web3d.org/x3d/specifications/vrml/ISO- IEC-14772-VRML97/part1/concepts.html#4.4.4), and 4.4.5, Standard units and coordinate system (http://www.web3d.org/x3d/specifications/vrml/ISO- IEC-14772-VRML97/part1/concepts.html#4.4.5), for a description of coordinate systems and transformations. 4.6.5, Grouping and children nodes (http://www.web3d.org/x3d/specifications/vrml/ISO- IEC-14772-VRML97/part1/concepts.html#4.6.5), provides a description of the children, addChildren, and removeChildren fields and eventIns. The bboxCenter and bboxSize fields specify a bounding box that encloses the children of the Transform node. This is a hint that may be used for optimization purposes. The results are undefined if the specified bounding box is smaller than the actual bounding box of the children at any time. A default bboxSize value, (-1, -1, -1), implies that the bounding box is not specified and, if needed, shall be calculated by the browser. The bounding box shall be large enough at all times to enclose the union of the group's children's bounding boxes; it shall not include any transformations performed by the group itself (i.e., the bounding box is defined in the local coordinate system of the children). The results are undefined if the specified bounding box is smaller than the true bounding box of the group. A description of the bboxCenter and bboxSize fields is provided in 4.6.4, Bounding boxes (http://www.web3d.org/x3d/specifications/vrml/ISO- IEC-14772-VRML97/part1/concepts.html#4.6.4). 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; · a translation. Thecenterfield specifies a translation offset from the origin of the local coordinate system (0,0,0). Therotationfield specifies a rotation of the coordinate system. Thescalefield specifies a non-uniform scale of the coordinate system. scale values shall be greater than zero. ThescaleOrientationspecifies a rotation of the coordinate system before the scale (to specify scales in arbitrary orientations). The scaleOrientation applies only to the scale operation. Thetranslationfield 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 × C × R × SR × S × -SR × -C × P The following Transform node: Transform { center C rotation R scale S scaleOrientation SR translation T children [...] } is equivalent to the nested sequence of: Transform { translation T children Transform { translation C children Transform { rotation R children Transform { rotation SR children Transform { scale S children Transform { rotation -SR children Transform { translation -C children [...] } } } } } } }

**Constructor** **&** **Destructor** **Documentation**

SoVRMLTransform::SoVRMLTransform(void)Constructor.SoVRMLTransform::SoVRMLTransform(intnumchildren)Constructor.numchildrenis the expected number of children.SoVRMLTransform::~SoVRMLTransform()[protected],[virtual]Destructor

**Member** **Function** **Documentation**

SoTypeSoVRMLTransform::getTypeId(void)const[virtual]Returns the type identification of an object derived from a class inheritingSoBase. This is used for run-time type checking and 'downward' casting. Usage example: void foo(SoNode * node) { if (node->getTypeId() == SoFile::getClassTypeId()) { SoFile * filenode = (SoFile *)node; // safe downward cast, knows the type } } For application programmers wanting to extend the library with new nodes, engines, nodekits, draggers or others: this method needs to be overridden inallsubclasses. This is typically done as part of setting up the full type system for extension classes, which is usually accomplished by using the pre-defined macros available through for instanceInventor/nodes/SoSubNode.h(SO_NODE_INIT_CLASS and SO_NODE_CONSTRUCTOR for node classes), Inventor/engines/SoSubEngine.h (for engine classes) and so on. For more information on writing Coin extensions, see the class documentation of the toplevel superclasses for the various class groups. Reimplemented fromSoVRMLGroup.constSoFieldData*SoVRMLTransform::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 fromSoVRMLGroup.voidSoVRMLTransform::pointAt(constSbVec3f&from,constSbVec3f&to)Sets the transformation to translate tofrompoint, with a rotation so that the (0,0,-1) vector is rotated into the vector fromfrompointtotopoint.voidSoVRMLTransform::getScaleSpaceMatrix(SbMatrix&matrix,SbMatrix&inverse)constCalculates the matrices to/from scale space.voidSoVRMLTransform::getRotationSpaceMatrix(SbMatrix&matrix,SbMatrix&inverse)constCalculates the matrices to/from rotation space.voidSoVRMLTransform::getTranslationSpaceMatrix(SbMatrix&matrix,SbMatrix&inverse)constCalculates the matrices to/from translation space.voidSoVRMLTransform::multLeft(constSbMatrix&matrix)Premultiplies this transformation bymat.voidSoVRMLTransform::multRight(constSbMatrix&matrix)Postmultiplies this transformation bymat.voidSoVRMLTransform::combineLeft(SoVRMLTransform*leftnode)Premultiplies this transformation by the transformation inleftnode.voidSoVRMLTransform::combineRight(SoVRMLTransform*rightnode)Postmultiplies this transformation by the transformation inrightnode.voidSoVRMLTransform::setMatrix(constSbMatrix&matrix)Sets the fields to create a transformation equal tomat.voidSoVRMLTransform::recenter(constSbVec3f&newcenter)Sets thecenterfield tonewcenter. This might affect one or more of the other fields.voidSoVRMLTransform::doAction(SoAction*action)[virtual]This function performs the typical operation of a node for any action. Reimplemented fromSoVRMLGroup.voidSoVRMLTransform::callback(SoCallbackAction*action)[virtual]Action method forSoCallbackAction. Simply updates the state according to how the node behaves for the render action, so the application programmer can use theSoCallbackActionfor extracting information about the scene graph. Reimplemented fromSoVRMLGroup.voidSoVRMLTransform::getBoundingBox(SoGetBoundingBoxAction*action)[virtual]Action method for theSoGetBoundingBoxAction. Calculates bounding box and center coordinates for node and modifies the values of theactionto encompass the bounding box for this node and to shift the center point for the scene more towards the one for this node. Nodes influencing how geometry nodes calculates their bounding box also overrides this method to change the relevant state variables. Reimplemented fromSoVRMLGroup.voidSoVRMLTransform::getMatrix(SoGetMatrixAction*action)[virtual]Action method forSoGetMatrixAction. Updatesactionby accumulating with the transformation matrix of this node (if any). Reimplemented fromSoVRMLGroup.voidSoVRMLTransform::rayPick(SoRayPickAction*action)[virtual]Action method forSoRayPickAction. Checks the ray specification of theactionand tests for intersection with the data of the node. Nodes influencing relevant state variables for how picking is done also overrides this method. Reimplemented fromSoVRMLGroup.voidSoVRMLTransform::getPrimitiveCount(SoGetPrimitiveCountAction*action)[virtual]Action method for theSoGetPrimitiveCountAction. Calculates the number of triangle, line segment and point primitives for the node and adds these to the counters of theaction. Nodes influencing how geometry nodes calculates their primitive count also overrides this method to change the relevant state variables. Reimplemented fromSoVRMLGroup.voidSoVRMLTransform::audioRender(SoAudioRenderAction*action)[virtual]Action method forSoAudioRenderAction. Does common processing forSoAudioRenderActionactioninstances. Reimplemented fromSoVRMLGroup.voidSoVRMLTransform::GLRenderBelowPath(SoGLRenderAction*action)[virtual]Implements the SoAction::BELOW_PATH traversal method for the rendering action. Reimplemented fromSoVRMLGroup.voidSoVRMLTransform::GLRenderInPath(SoGLRenderAction*action)[virtual]Implements the SoAction::IN_PATH traversal method for the rendering action. Reimplemented fromSoVRMLGroup.voidSoVRMLTransform::notify(SoNotList*l)[virtual]Notifies all auditors for this instance when changes are made. Reimplemented fromSoVRMLGroup.

**Member** **Data** **Documentation**

SoSFVec3fSoVRMLTransform::translationThe translation vector. Default value is (0, 0, 0).SoSFRotationSoVRMLTransform::rotationThe rotation around the center point. Default value is null-rotation.SoSFVec3fSoVRMLTransform::scaleThe scale vector about the center point. Default value is (1, 1, 1).SoSFRotationSoVRMLTransform::scaleOrientationThe scale orientation. Default value is a null-rotation.SoSFVec3fSoVRMLTransform::centerThe center point. Default value is (0, 0, 0).

**Author**

Generated automatically by Doxygen for Coin from the source code.