The FitToBoxTransform node is a MatrixTransform that is used when one wants to transform a part of a scene into a specific region in the coordinate space. More...
#include <H3D/FitToBoxTransform.h>
Inheritance diagram for H3D::FitToBoxTransform:
Classes | |
| class | SFMatrix4f |
| We specialize the SFMatrix4f field to that update itself from a SFBound field and two SFVec3f fields. More... | |
Public Member Functions | |
| FitToBoxTransform (Inst< AddChildren > _addChildren=0, Inst< RemoveChildren > _removeChildren=0, Inst< MFChild > _children=0, Inst< SFNode > _metadata=0, Inst< SFBound > _bound=0, Inst< SFVec3f > _bboxCenter=0, Inst< SFVec3f > _bboxSize=0, Inst< SFTransformedBound > _transformedBound=0, Inst< SFMatrix4f > _matrix=0, Inst< SFVec3f > _boxSize=0, Inst< SFVec3f > _boxCenter=0, Inst< SFBool > _uniformScalingOnly=0, Inst< SFBool > _active=0) | |
| Constructor. | |
 Public Member Functions inherited from H3D::MatrixTransform | |
| MatrixTransform (Inst< AddChildren > _addChildren=0, Inst< RemoveChildren > _removeChildren=0, Inst< MFChild > _children=0, Inst< SFNode > _metadata=0, Inst< SFBound > _bound=0, Inst< SFVec3f > _bboxCenter=0, Inst< SFVec3f > _bboxSize=0, Inst< SFTransformedBound > _transformedBound=0, Inst< SFMatrix4f > _matrix=0, Inst< SFMatrix4f > _accumulatedForward=0, Inst< SFMatrix4f > _accumulatedInverse=0) | |
| Constructor. | |
| virtual void | render () |
| Render the children. | |
| virtual void | traverseSG (TraverseInfo &ti) |
| Traverse the scenegraph. | |
| void | multiplyGLMatrix () |
| Multiply the currently active OpenGL matrix with the matrix of this node. | |
| virtual bool | lineIntersect (const Vec3f &from, const Vec3f &to, LineIntersectResult &result) |
| Detect intersection between a line segment and this Node. More... | |
| virtual void | closestPoint (const Vec3f &p, NodeIntersectResult &result) |
| Find closest point on Node to p. More... | |
| virtual bool | movingSphereIntersect (H3DFloat radius, const Vec3f &from, const Vec3f &to, NodeIntersectResult &result) |
| Detect collision between a moving sphere and the Node. More... | |
| Public Member Functions inherited from H3D::X3DGroupingNode | |
| X3DGroupingNode (Inst< AddChildren > _addChildren=0, Inst< RemoveChildren > _removeChildren=0, Inst< MFChild > _children=0, Inst< SFNode > _metadata=0, Inst< SFBound > _bound=0, Inst< SFVec3f > _bboxCenter=0, Inst< SFVec3f > _bboxSize=0) | |
| Constructor. | |
| virtual | ~X3DGroupingNode () |
| Destructor. | |
| virtual void | initialize () |
| Sets up the bound field using the bboxCenter and bboxSize fields. More... | |
| Public Member Functions inherited from H3D::X3DChildNode | |
| X3DChildNode (Inst< SFNode > _metadata=0) | |
| Constructor. | |
| Public Member Functions inherited from H3D::X3DNode | |
| X3DNode (Inst< SFNode > _metadata=0) | |
| Constructor. | |
| X3DMetadataObject * | getMetadataByName (const string &_name) |
| Given a name, the first X3DMetadataObject in the metadata field that matches that name is returned. More... | |
| Public Member Functions inherited from H3D::Node | |
| Node () | |
| Constructor. | |
| virtual Node * | clone (bool deepCopy=true, DeepCopyMap *deepCopyMap=NULL) |
| Returns a new instance of this node type with the same state as this one. More... | |
| virtual | ~Node () |
| Destructor. | |
| X3DPrototypeInstance * | getProtoInstanceParent () |
| If this node is the root node in the proto body of a X3DPrototypeInstance then this will return that node. More... | |
| void | setProtoInstanceParent (X3DPrototypeInstance *p) |
| Set the X3DPrototypeInstance this node is the the root node if applicaple. | |
| virtual string | defaultXMLContainerField () |
| Returns the default xml containerField attribute value. More... | |
| virtual Field * | getField (const string &_name) const |
| return a pointer to the field specified by name within this instance | |
| int | addDestructCallback (void(*func)(Node *, void *), void *args) |
| Add a callback function to be run on destruction of node. More... | |
| int | removeDestructCallback (void(*func)(Node *, void *), void *args) |
| Add a callback function to be run on destruction of node. More... | |
| Public Member Functions inherited from H3D::H3DBoundedObject | |
| H3DBoundedObject (Inst< SFBound > _bound=0) | |
| Constructor. | |
| Public Member Functions inherited from H3D::H3DDisplayListObject | |
| H3DDisplayListObject (Inst< DisplayList > _displayList=0) | |
| Constructor. | |
Public Attributes | |
| H3DUniquePtr< SFVec3f > | boxSize |
| The size of the box we want to transform into. More... | |
| H3DUniquePtr< SFVec3f > | boxCenter |
| The center of the box we want to transform into. More... | |
| H3DUniquePtr< SFBool > | uniformScalingOnly |
| Determines if uniform scaling only should be used, or if nonuniform scaling is allowed. More... | |
| H3DUniquePtr< SFBool > | active |
| Determines if the transformation matrix should be updated or not. More... | |
| Public Attributes inherited from H3D::MatrixTransform | |
| H3DUniquePtr< SFMatrix4f > | matrix |
| The transformation matrix. More... | |
| H3DUniquePtr< SFMatrix4f > | accumulatedForward |
| The accumulated forward transform matrix, i.e. More... | |
| H3DUniquePtr< SFMatrix4f > | accumulatedInverse |
| The accumulated inverse transform matrix, i.e. More... | |
| H3DUniquePtr< SFTransformedBound > | transformedBound |
| This is the same as the bound field, but with the transformation applied to the bound. More... | |
| Public Attributes inherited from H3D::X3DGroupingNode | |
| bool | use_union_bound |
| if true a route will be set up between the bound field of the nodes in children and the bound field of the grouping node. More... | |
| H3DUniquePtr< AddChildren > | addChildren |
| The addChildren event appends nodes to the children field of a grouping node. More... | |
| H3DUniquePtr< RemoveChildren > | removeChildren |
| The removeChildren event removes nodes from the children field of the grouping node . More... | |
| H3DUniquePtr< MFChild > | children |
| The nodes that are grouped together by this node. More... | |
| Public Attributes inherited from H3D::X3DNode | |
| H3DUniquePtr< SFNode > | metadata |
| Meta data about the node. More... | |
| Public Attributes inherited from H3D::X3DBoundedObject | |
| H3DUniquePtr< SFVec3f > | bboxCenter |
| Specifies a the center of an axis-aligned bounding box enclosing the node. More... | |
| H3DUniquePtr< SFVec3f > | bboxSize |
| Specifies a the size of an axis-aligned bounding box enclosing the node. More... | |
| Public Attributes inherited from H3D::H3DBoundedObject | |
| H3DUniquePtr< SFBound > | bound |
| The field containing the bound object. More... | |
| Public Attributes inherited from H3D::H3DDisplayListObject | |
| H3DUniquePtr< DisplayList > | displayList |
| The DisplayList instance handling the OpenGL caching of this object. | |
Static Public Attributes | |
| static H3DNodeDatabase | database |
| The H3DNodeDatabase for this node. | |
| Static Public Attributes inherited from H3D::MatrixTransform | |
| static H3DNodeDatabase | database |
| The H3DNodeDatabase for this node. | |
| Static Public Attributes inherited from H3D::X3DGroupingNode | |
| static H3DNodeDatabase | database |
| The H3DNodeDatabase for this node. | |
| Static Public Attributes inherited from H3D::X3DNode | |
| static H3DNodeDatabase | database |
| The H3DNodeDatabase for this node. | |
Additional Inherited Members | |
| Public Types inherited from H3D::Node | |
| typedef std::map< Node *, Node * > | DeepCopyMap |
| A map type used during a deep copy clone() to map from original nodes to cloned nodes. | |
| Static Public Member Functions inherited from H3D::Node | |
| static unsigned int | nrNodesAlive () |
| Returns the nr of nodes currently alive, i.e. nodes created but not destructed. | |
| static int | nrNodesCreated () |
| Returns the number of nodes created in total since the start of the program. | |
| Protected Member Functions inherited from H3D::Node | |
| void | cloneFieldValue (Field &_from, Field &_to, bool deepCopy, DeepCopyMap &deepCopyMap) |
| A helper function for the clone() method. More... | |
| Static Protected Member Functions inherited from H3D::Node | |
| static Node * | getClonedInstance (Node *original, bool deepCopy, DeepCopyMap &deepCopyMap) |
| A helper function for nodes that implement clone() More... | |
| Protected Attributes inherited from H3D::X3DGroupingNode | |
| bool | children_multi_pass_transparency |
| Will be set in traverseSG to indicate if any of the children enables multi-pass transparency. More... | |
| vector< H3DRenderStateObject * > | render_states |
| A vector of all the H3DRenderStatesObject within this X3DGroupingNode. | |
| vector< ClipPlane * > | clip_planes |
| A vector of only ClipPlane children of this X3DGroupingNode. | |
Detailed Description
The FitToBoxTransform node is a MatrixTransform that is used when one wants to transform a part of a scene into a specific region in the coordinate space.
The region to transform into is defined by a box using the boxCenter and boxSize fields. The bounding box of the FitToBoxTransform node is then used to determine the scale and translation needed to fit that bounding box into the box defined. The uniformScalingOnly determines if the scaling should be uniform or if nonuniform scaling can be used. Nonuniform scaling will fit the children more accurately into the box, while uniform scaling will preserve the ratio of the dimentions of the objects. The active field can be used to control if the transformation matrix should be updated or not. If active is true the matrix will be updated.
Examples:
- Internal routes:
Member Data Documentation
◆ active
| H3DUniquePtr< SFBool > H3D::FitToBoxTransform::active |
Determines if the transformation matrix should be updated or not.
Access type: inputOutput
Default value: TRUE
Referenced by FitToBoxTransform().
◆ boxCenter
| H3DUniquePtr< SFVec3f > H3D::FitToBoxTransform::boxCenter |
The center of the box we want to transform into.
Access type: inputOutput
Default value: Vec3f( 0.1, 0.1, 0.1 )
Referenced by FitToBoxTransform().
◆ boxSize
| H3DUniquePtr< SFVec3f > H3D::FitToBoxTransform::boxSize |
The size of the box we want to transform into.
Access type: inputOutput
Default value: Vec3f( 0, 0, 0 )
Valid range: >0
Referenced by FitToBoxTransform().
◆ uniformScalingOnly
| H3DUniquePtr< SFBool > H3D::FitToBoxTransform::uniformScalingOnly |
Determines if uniform scaling only should be used, or if nonuniform scaling is allowed.
Access type: inputOutput
Default value: FALSE
Referenced by FitToBoxTransform().
The documentation for this class was generated from the following files:
