OpenSceneGraph  3.0.1
Public Types | Public Member Functions | Protected Types | Protected Member Functions | Protected Attributes
osg::AutoTransform Class Reference

AutoTransform is a derived form of Transform that automatically scales or rotates to keep its children aligned with screen coordinates. More...

Inheritance diagram for osg::AutoTransform:
Inheritance graph
[legend]

List of all members.

Public Types

enum  AutoRotateMode { NO_ROTATION, ROTATE_TO_SCREEN, ROTATE_TO_CAMERA, ROTATE_TO_AXIS }
- Public Types inherited from osg::Transform
enum  ReferenceFrame { RELATIVE_RF, ABSOLUTE_RF, ABSOLUTE_RF_INHERIT_VIEWPOINT }

Public Member Functions

 AutoTransform ()
 AutoTransform (const AutoTransform &pat, const CopyOp &copyop=CopyOp::SHALLOW_COPY)
virtual osg::ObjectcloneType () const
 clone an object of the same type as the node.
virtual osg::Objectclone (const osg::CopyOp &copyop) const
 return a clone of a node, with Object* return type.
virtual bool isSameKindAs (const osg::Object *obj) const
 return true if this and obj are of the same kind of object.
virtual const char * className () const
 return the name of the node's class type.
virtual const char * libraryName () const
 return the name of the node's library.
virtual void accept (NodeVisitor &nv)
 Visitor Pattern : calls the apply method of a NodeVisitor with this node's type.
virtual AutoTransformasAutoTransform ()
virtual const AutoTransformasAutoTransform () const
void setPosition (const Vec3d &pos)
const Vec3dgetPosition () const
void setRotation (const Quat &quat)
const QuatgetRotation () const
void setScale (double scale)
void setScale (const Vec3d &scale)
const Vec3dgetScale () const
void setMinimumScale (double minimumScale)
double getMinimumScale () const
void setMaximumScale (double maximumScale)
double getMaximumScale () const
void setPivotPoint (const Vec3d &pivot)
const Vec3dgetPivotPoint () const
void setAutoUpdateEyeMovementTolerance (float tolerance)
float getAutoUpdateEyeMovementTolerance () const
void setAutoRotateMode (AutoRotateMode mode)
AutoRotateMode getAutoRotateMode () const
void setAxis (const Vec3 &axis)
 Set the rotation axis for the AutoTransform's child nodes.
const Vec3getAxis () const
 Get the rotation axis.
void setNormal (const Vec3 &normal)
 This normal defines child Nodes' front face direction when unrotated.
const Vec3getNormal () const
 Get the front face direction normal.
void setAutoScaleToScreen (bool autoScaleToScreen)
bool getAutoScaleToScreen () const
void setAutoScaleTransitionWidthRatio (float ratio)
float getAutoScaleTransitionWidthRatio () const
virtual bool computeLocalToWorldMatrix (Matrix &matrix, NodeVisitor *nv) const
virtual bool computeWorldToLocalMatrix (Matrix &matrix, NodeVisitor *nv) const
virtual BoundingSphere computeBound () const
 Overrides Group's computeBound.
- Public Member Functions inherited from osg::Transform
 Transform ()
 Transform (const Transform &, const CopyOp &copyop=CopyOp::SHALLOW_COPY)
 Copy constructor using CopyOp to manage deep vs shallow copy.
 META_Node (osg, Transform)
virtual TransformasTransform ()
 Convert 'this' into a Transform pointer if Node is a Transform, otherwise return 0.
virtual const TransformasTransform () const
 convert 'const this' into a const Transform pointer if Node is a Transform, otherwise return 0.
virtual MatrixTransformasMatrixTransform ()
virtual const MatrixTransformasMatrixTransform () const
virtual PositionAttitudeTransformasPositionAttitudeTransform ()
virtual const
PositionAttitudeTransform
asPositionAttitudeTransform () const
void setReferenceFrame (ReferenceFrame rf)
 Set the transform's ReferenceFrame, either to be relative to its parent reference frame, or relative to an absolute coordinate frame.
ReferenceFrame getReferenceFrame () const
- Public Member Functions inherited from osg::Group
 Group ()
 Group (const Group &, const CopyOp &copyop=CopyOp::SHALLOW_COPY)
 Copy constructor using CopyOp to manage deep vs shallow copy.
 META_Node (osg, Group)
virtual GroupasGroup ()
 convert 'this' into a Group pointer if Node is a Group, otherwise return 0.
virtual const GroupasGroup () const
 convert 'const this' into a const Group pointer if Node is a Group, otherwise return 0.
virtual void traverse (NodeVisitor &nv)
 Traverse downwards : calls children's accept method with NodeVisitor.
virtual bool addChild (Node *child)
 Add Node to Group.
virtual bool insertChild (unsigned int index, Node *child)
 Insert Node to Group at specific location.
bool removeChild (Node *child)
 Remove Node from Group.
bool removeChild (unsigned int pos, unsigned int numChildrenToRemove=1)
 Remove Node from Group.
virtual bool removeChildren (unsigned int pos, unsigned int numChildrenToRemove)
 Remove children from Group.
virtual bool replaceChild (Node *origChild, Node *newChild)
 Replace specified Node with another Node.
unsigned int getNumChildren () const
 Return the number of children nodes.
virtual bool setChild (unsigned int i, Node *node)
 Set child node at position i.
NodegetChild (unsigned int i)
 Return child node at position i.
const NodegetChild (unsigned int i) const
 Return child node at position i.
bool containsNode (const Node *node) const
 Return true if node is contained within Group.
unsigned int getChildIndex (const Node *node) const
 Get the index number of child, return a value between 0 and _children.size()-1 if found, if not found then return _children.size().
virtual void setThreadSafeRefUnref (bool threadSafe)
 Set whether to use a mutex to ensure ref() and unref() are thread safe.
virtual void resizeGLObjectBuffers (unsigned int maxSize)
 Resize any per context GLObject buffers to specified size.
virtual void releaseGLObjects (osg::State *=0) const
 If State is non-zero, this function releases any associated OpenGL objects for the specified graphics context.
- Public Member Functions inherited from osg::Node
 Node ()
 Construct a node.
 Node (const Node &, const CopyOp &copyop=CopyOp::SHALLOW_COPY)
 Copy constructor using CopyOp to manage deep vs shallow copy.
virtual SwitchasSwitch ()
 Convert 'this' into a Switch pointer if Node is a Switch, otherwise return 0.
virtual const SwitchasSwitch () const
 convert 'const this' into a const Switch pointer if Node is a Switch, otherwise return 0.
virtual GeodeasGeode ()
 Convert 'this' into a Geode pointer if Node is a Geode, otherwise return 0.
virtual const GeodeasGeode () const
 convert 'const this' into a const Geode pointer if Node is a Geode, otherwise return 0.
virtual osgTerrain::TerrainasTerrain ()
 Convert 'this' into a Transform pointer if Node is a Terrain, otherwise return 0.
virtual const osgTerrain::TerrainasTerrain () const
 convert 'const this' into a const Terrain pointer if Node is a Terrain, otherwise return 0.
virtual void ascend (NodeVisitor &nv)
 Traverse upwards : calls parents' accept method with NodeVisitor.
const ParentListgetParents () const
 Get the parent list of node.
ParentList getParents ()
 Get the a copy of parent list of node.
GroupgetParent (unsigned int i)
const GroupgetParent (unsigned int i) const
 Get a single const parent of node.
unsigned int getNumParents () const
 Get the number of parents of node.
NodePathList getParentalNodePaths (osg::Node *haltTraversalAtNode=0) const
 Get the list of node paths parent paths.
MatrixList getWorldMatrices (const osg::Node *haltTraversalAtNode=0) const
 Get the list of matrices that transform this node from local coordinates to world coordinates.
void setUpdateCallback (NodeCallback *nc)
 Set update node callback, called during update traversal.
NodeCallbackgetUpdateCallback ()
 Get update node callback, called during update traversal.
const NodeCallbackgetUpdateCallback () const
 Get const update node callback, called during update traversal.
void addUpdateCallback (NodeCallback *nc)
 Convenience method that sets the update callback of the node if it doesn't exist, or nest it into the existing one.
void removeUpdateCallback (NodeCallback *nc)
 Convenience method that removes a given callback from a node, even if that callback is nested.
unsigned int getNumChildrenRequiringUpdateTraversal () const
 Get the number of Children of this node which require Update traversal, since they have an Update Callback attached to them or their children.
void setEventCallback (NodeCallback *nc)
 Set event node callback, called during event traversal.
NodeCallbackgetEventCallback ()
 Get event node callback, called during event traversal.
const NodeCallbackgetEventCallback () const
 Get const event node callback, called during event traversal.
void addEventCallback (NodeCallback *nc)
 Convenience method that sets the event callback of the node if it doesn't exist, or nest it into the existing one.
void removeEventCallback (NodeCallback *nc)
 Convenience method that removes a given callback from a node, even if that callback is nested.
unsigned int getNumChildrenRequiringEventTraversal () const
 Get the number of Children of this node which require Event traversal, since they have an Event Callback attached to them or their children.
void setCullCallback (NodeCallback *nc)
 Set cull node callback, called during cull traversal.
NodeCallbackgetCullCallback ()
 Get cull node callback, called during cull traversal.
const NodeCallbackgetCullCallback () const
 Get const cull node callback, called during cull traversal.
void addCullCallback (NodeCallback *nc)
 Convenience method that sets the cull callback of the node if it doesn't exist, or nest it into the existing one.
void removeCullCallback (NodeCallback *nc)
 Convenience method that removes a given callback from a node, even if that callback is nested.
void setCullingActive (bool active)
 Set the view frustum/small feature culling of this node to be active or inactive.
bool getCullingActive () const
 Get the view frustum/small feature _cullingActive flag for this node.
unsigned int getNumChildrenWithCullingDisabled () const
 Get the number of Children of this node which have culling disabled.
bool isCullingActive () const
 Return true if this node can be culled by view frustum, occlusion or small feature culling during the cull traversal.
unsigned int getNumChildrenWithOccluderNodes () const
 Get the number of Children of this node which are or have OccluderNode's.
bool containsOccluderNodes () const
 return true if this node is an OccluderNode or the subgraph below this node are OccluderNodes.
void setNodeMask (NodeMask nm)
 Set the node mask.
NodeMask getNodeMask () const
 Get the node Mask.
void setStateSet (osg::StateSet *stateset)
 Set the node's StateSet.
osg::StateSetgetOrCreateStateSet ()
 return the node's StateSet, if one does not already exist create it set the node and return the newly created StateSet.
osg::StateSetgetStateSet ()
 Return the node's StateSet.
const osg::StateSetgetStateSet () const
 Return the node's const StateSet.
void setDescriptions (const DescriptionList &descriptions)
 Set the list of string descriptions.
DescriptionListgetDescriptions ()
 Get the description list of the node.
const DescriptionListgetDescriptions () const
 Get the const description list of the const node.
const std::string & getDescription (unsigned int i) const
 Get a single const description of the const node.
std::string & getDescription (unsigned int i)
 Get a single description of the node.
unsigned int getNumDescriptions () const
 Get the number of descriptions of the node.
void addDescription (const std::string &desc)
 Add a description string to the node.
void setInitialBound (const osg::BoundingSphere &bsphere)
 Set the initial bounding volume to use when computing the overall bounding volume.
const BoundingSpheregetInitialBound () const
 Set the initial bounding volume to use when computing the overall bounding volume.
void dirtyBound ()
 Mark this node's bounding sphere dirty.
const BoundingSpheregetBound () const
 Get the bounding sphere of node.
void setComputeBoundingSphereCallback (ComputeBoundingSphereCallback *callback)
 Set the compute bound callback to override the default computeBound.
ComputeBoundingSphereCallbackgetComputeBoundingSphereCallback ()
 Get the compute bound callback.
const
ComputeBoundingSphereCallback
getComputeBoundingSphereCallback () const
 Get the const compute bound callback.
- Public Member Functions inherited from osg::Object
 Object ()
 Construct an object.
 Object (bool threadSafeRefUnref)
 Object (const Object &, const CopyOp &copyop=CopyOp::SHALLOW_COPY)
 Copy constructor, optional CopyOp object can be used to control shallow vs deep copying of dynamic data.
virtual void setName (const std::string &name)
 Set the name of object using C++ style string.
void setName (const char *name)
 Set the name of object using a C style string.
const std::string & getName () const
 Get the name of object.
void setDataVariance (DataVariance dv)
 Set the data variance of this object.
DataVariance getDataVariance () const
 Get the data variance of this object.
virtual void computeDataVariance ()
 Compute the DataVariance based on an assessment of callback etc.
void setUserDataContainer (osg::UserDataContainer *udc)
 set the UserDataContainer object.
osg::UserDataContainergetUserDataContainer ()
 get the UserDataContainer attached to this object.
const osg::UserDataContainergetUserDataContainer () const
 get the const UserDataContainer attached to this object.
osg::UserDataContainergetOrCreateUserDataContainer ()
 Convinience method that returns the UserDataContainer, and if one doesn't already exist creates and assigns a DefaultUserDataContainer to the Object and then return this new UserDataContainer.
virtual void setUserData (Referenced *obj)
 Set user data, data must be subclassed from Referenced to allow automatic memory handling.
virtual ReferencedgetUserData ()
 Get user data.
virtual const ReferencedgetUserData () const
 Get const user data.
template<typename T >
bool getUserValue (const std::string &name, T &value) const
 Convinience method that casts the named UserObject to osg::TemplateValueObject<T> and gets the value.
template<typename T >
void setUserValue (const std::string &name, const T &value)
 Convinience method that creates the osg::TemplateValueObject<T> to store the specified value and adds it as a named UserObject.
- Public Member Functions inherited from osg::Referenced
 Referenced ()
 Referenced (bool threadSafeRefUnref)
 Referenced (const Referenced &)
Referencedoperator= (const Referenced &)
bool getThreadSafeRefUnref () const
 Get whether a mutex is used to ensure ref() and unref() are thread safe.
OpenThreads::Mutex * getRefMutex () const
 Get the mutex used to ensure thread safety of ref()/unref().
int ref () const
 Increment the reference count by one, indicating that this object has another pointer which is referencing it.
int unref () const
 Decrement the reference count by one, indicating that a pointer to this object is referencing it.
int unref_nodelete () const
 Decrement the reference count by one, indicating that a pointer to this object is referencing it.
int referenceCount () const
 Return the number of pointers currently referencing this object.
ObserverSetgetObserverSet () const
 Get the ObserverSet if one is attached, otherwise return NULL.
ObserverSetgetOrCreateObserverSet () const
 Get the ObserverSet if one is attached, otherwise create an ObserverSet, attach it, then return this newly created ObserverSet.
void addObserver (Observer *observer) const
 Add a Observer that is observing this object, notify the Observer when this object gets deleted.
void removeObserver (Observer *observer) const
 Remove Observer that is observing this object.

Protected Types

enum  AxisAligned { AXIAL_ROT_X_AXIS = ROTATE_TO_AXIS+1, AXIAL_ROT_Y_AXIS, AXIAL_ROT_Z_AXIS, CACHE_DIRTY }

Protected Member Functions

virtual ~AutoTransform ()
void computeMatrix () const
void updateCache ()
- Protected Member Functions inherited from osg::Transform
virtual ~Transform ()
- Protected Member Functions inherited from osg::Group
virtual ~Group ()
virtual void childRemoved (unsigned int, unsigned int)
virtual void childInserted (unsigned int)
- Protected Member Functions inherited from osg::Node
virtual ~Node ()
 Node destructor.
void addParent (osg::Group *node)
void removeParent (osg::Group *node)
void setNumChildrenRequiringUpdateTraversal (unsigned int num)
void setNumChildrenRequiringEventTraversal (unsigned int num)
void setNumChildrenWithCullingDisabled (unsigned int num)
void setNumChildrenWithOccluderNodes (unsigned int num)
- Protected Member Functions inherited from osg::Object
virtual ~Object ()
 Object destructor.
- Protected Member Functions inherited from osg::Referenced
virtual ~Referenced ()
void signalObserversAndDelete (bool signalDelete, bool doDelete) const
void deleteUsingDeleteHandler () const

Protected Attributes

Vec3d _position
Vec3d _pivotPoint
double _autoUpdateEyeMovementTolerance
AutoRotateMode _autoRotateMode
bool _autoScaleToScreen
Quat _rotation
Vec3d _scale
bool _firstTimeToInitEyePoint
osg::Vec3 _previousEyePoint
osg::Vec3 _previousLocalUp
Viewport::value_type _previousWidth
Viewport::value_type _previousHeight
osg::Matrixd _previousProjection
osg::Vec3d _previousPosition
double _minimumScale
double _maximumScale
double _autoScaleTransitionWidthRatio
bool _matrixDirty
osg::Matrixd _cachedMatrix
Vec3 _axis
Vec3 _normal
int _cachedMode
Vec3 _side
- Protected Attributes inherited from osg::Transform
ReferenceFrame _referenceFrame
- Protected Attributes inherited from osg::Group
NodeList _children
- Protected Attributes inherited from osg::Node
BoundingSphere _initialBound
ref_ptr
< ComputeBoundingSphereCallback
_computeBoundCallback
BoundingSphere _boundingSphere
bool _boundingSphereComputed
ParentList _parents
ref_ptr< NodeCallback_updateCallback
unsigned int _numChildrenRequiringUpdateTraversal
ref_ptr< NodeCallback_eventCallback
unsigned int _numChildrenRequiringEventTraversal
ref_ptr< NodeCallback_cullCallback
bool _cullingActive
unsigned int _numChildrenWithCullingDisabled
unsigned int _numChildrenWithOccluderNodes
NodeMask _nodeMask
ref_ptr< StateSet_stateset
- Protected Attributes inherited from osg::Object
std::string _name
DataVariance _dataVariance
osg::UserDataContainer_userDataContainer
- Protected Attributes inherited from osg::Referenced
OpenThreads::AtomicPtr _observerSet
OpenThreads::Atomic _refCount

Detailed Description

AutoTransform is a derived form of Transform that automatically scales or rotates to keep its children aligned with screen coordinates.


Member Enumeration Documentation

Enumerator:
NO_ROTATION 
ROTATE_TO_SCREEN 
ROTATE_TO_CAMERA 
ROTATE_TO_AXIS 
Enumerator:
AXIAL_ROT_X_AXIS 
AXIAL_ROT_Y_AXIS 
AXIAL_ROT_Z_AXIS 
CACHE_DIRTY 

Constructor & Destructor Documentation

osg::AutoTransform::AutoTransform ( )
osg::AutoTransform::AutoTransform ( const AutoTransform pat,
const CopyOp copyop = CopyOp::SHALLOW_COPY 
)
virtual osg::AutoTransform::~AutoTransform ( )
inlineprotectedvirtual

Member Function Documentation

virtual void osg::AutoTransform::accept ( NodeVisitor nv)
virtual

Visitor Pattern : calls the apply method of a NodeVisitor with this node's type.

Reimplemented from osg::Node.

virtual AutoTransform* osg::AutoTransform::asAutoTransform ( )
inlinevirtual
virtual const AutoTransform* osg::AutoTransform::asAutoTransform ( ) const
inlinevirtual
virtual const char* osg::AutoTransform::className ( ) const
inlinevirtual

return the name of the node's class type.

Reimplemented from osg::Node.

virtual osg::Object* osg::AutoTransform::clone ( const osg::CopyOp copyop) const
inlinevirtual

return a clone of a node, with Object* return type.

Reimplemented from osg::Node.

virtual osg::Object* osg::AutoTransform::cloneType ( ) const
inlinevirtual

clone an object of the same type as the node.

Reimplemented from osg::Node.

virtual BoundingSphere osg::AutoTransform::computeBound ( ) const
virtual

Overrides Group's computeBound.

There is no need to override in subclasses from osg::Transform since this computeBound() uses the underlying matrix (calling computeMatrix if required).

Reimplemented from osg::Transform.

virtual bool osg::AutoTransform::computeLocalToWorldMatrix ( Matrix matrix,
NodeVisitor nv 
) const
virtual

Reimplemented from osg::Transform.

void osg::AutoTransform::computeMatrix ( ) const
protected
virtual bool osg::AutoTransform::computeWorldToLocalMatrix ( Matrix matrix,
NodeVisitor nv 
) const
virtual

Reimplemented from osg::Transform.

AutoRotateMode osg::AutoTransform::getAutoRotateMode ( ) const
inline
bool osg::AutoTransform::getAutoScaleToScreen ( ) const
inline
float osg::AutoTransform::getAutoScaleTransitionWidthRatio ( ) const
inline
float osg::AutoTransform::getAutoUpdateEyeMovementTolerance ( ) const
inline
const Vec3& osg::AutoTransform::getAxis ( ) const
inline

Get the rotation axis.

double osg::AutoTransform::getMaximumScale ( ) const
inline
double osg::AutoTransform::getMinimumScale ( ) const
inline
const Vec3& osg::AutoTransform::getNormal ( ) const
inline

Get the front face direction normal.

const Vec3d& osg::AutoTransform::getPivotPoint ( ) const
inline
const Vec3d& osg::AutoTransform::getPosition ( ) const
inline
const Quat& osg::AutoTransform::getRotation ( ) const
inline
const Vec3d& osg::AutoTransform::getScale ( ) const
inline
virtual bool osg::AutoTransform::isSameKindAs ( const osg::Object obj) const
inlinevirtual

return true if this and obj are of the same kind of object.

Reimplemented from osg::Node.

References NULL.

virtual const char* osg::AutoTransform::libraryName ( ) const
inlinevirtual

return the name of the node's library.

Reimplemented from osg::Node.

void osg::AutoTransform::setAutoRotateMode ( AutoRotateMode  mode)
void osg::AutoTransform::setAutoScaleToScreen ( bool  autoScaleToScreen)
inline
void osg::AutoTransform::setAutoScaleTransitionWidthRatio ( float  ratio)
inline
void osg::AutoTransform::setAutoUpdateEyeMovementTolerance ( float  tolerance)
inline
void osg::AutoTransform::setAxis ( const Vec3 axis)

Set the rotation axis for the AutoTransform's child nodes.

Only utilized when _autoRotateMode==ROTATE_TO_AXIS.

void osg::AutoTransform::setMaximumScale ( double  maximumScale)
inline
void osg::AutoTransform::setMinimumScale ( double  minimumScale)
inline
void osg::AutoTransform::setNormal ( const Vec3 normal)

This normal defines child Nodes' front face direction when unrotated.

void osg::AutoTransform::setPivotPoint ( const Vec3d pivot)
inline
void osg::AutoTransform::setPosition ( const Vec3d pos)
inline
void osg::AutoTransform::setRotation ( const Quat quat)
inline
void osg::AutoTransform::setScale ( double  scale)
inline

References setScale().

Referenced by setScale().

void osg::AutoTransform::setScale ( const Vec3d scale)
void osg::AutoTransform::updateCache ( )
protected

Member Data Documentation

AutoRotateMode osg::AutoTransform::_autoRotateMode
protected
bool osg::AutoTransform::_autoScaleToScreen
protected
double osg::AutoTransform::_autoScaleTransitionWidthRatio
protected
double osg::AutoTransform::_autoUpdateEyeMovementTolerance
protected
Vec3 osg::AutoTransform::_axis
protected
osg::Matrixd osg::AutoTransform::_cachedMatrix
mutableprotected
int osg::AutoTransform::_cachedMode
protected
bool osg::AutoTransform::_firstTimeToInitEyePoint
mutableprotected
bool osg::AutoTransform::_matrixDirty
mutableprotected
double osg::AutoTransform::_maximumScale
protected
double osg::AutoTransform::_minimumScale
protected
Vec3 osg::AutoTransform::_normal
protected
Vec3d osg::AutoTransform::_pivotPoint
protected
Vec3d osg::AutoTransform::_position
protected
osg::Vec3 osg::AutoTransform::_previousEyePoint
mutableprotected
Viewport::value_type osg::AutoTransform::_previousHeight
mutableprotected
osg::Vec3 osg::AutoTransform::_previousLocalUp
mutableprotected
osg::Vec3d osg::AutoTransform::_previousPosition
mutableprotected
osg::Matrixd osg::AutoTransform::_previousProjection
mutableprotected
Viewport::value_type osg::AutoTransform::_previousWidth
mutableprotected
Quat osg::AutoTransform::_rotation
mutableprotected
Vec3d osg::AutoTransform::_scale
mutableprotected
Vec3 osg::AutoTransform::_side
protected

The documentation for this class was generated from the following file:

osg logo
Generated at Sat Jan 12 2013 03:07:21 for the OpenSceneGraph by doxygen 1.8.1.1.