openscenegraph
Public Types | Public Member Functions | Protected Types | Protected Member Functions | Protected Attributes | List of all members
osg::AutoTransform Class Reference
Inheritance diagram for osg::AutoTransform:
osg::Transform osg::Group osg::Node osg::Object osg::Referenced

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
virtual osg::Objectclone (const osg::CopyOp &copyop) const
virtual bool isSameKindAs (const osg::Object *obj) const
virtual const char * className () const
virtual const char * libraryName () const
virtual void accept (NodeVisitor &nv)
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)
const Vec3getAxis () const
void setNormal (const Vec3 &normal)
const Vec3getNormal () const
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
- Public Member Functions inherited from osg::Transform
 Transform ()
 Transform (const Transform &, const CopyOp &copyop=CopyOp::SHALLOW_COPY)
 META_Node (osg, Transform)
virtual TransformasTransform ()
virtual const TransformasTransform () const
virtual MatrixTransformasMatrixTransform ()
virtual const MatrixTransformasMatrixTransform () const
virtual PositionAttitudeTransformasPositionAttitudeTransform ()
virtual const
PositionAttitudeTransform
asPositionAttitudeTransform () const
void setReferenceFrame (ReferenceFrame rf)
ReferenceFrame getReferenceFrame () const
- Public Member Functions inherited from osg::Group
 Group ()
 Group (const Group &, const CopyOp &copyop=CopyOp::SHALLOW_COPY)
 META_Node (osg, Group)
virtual GroupasGroup ()
virtual const GroupasGroup () const
virtual void traverse (NodeVisitor &nv)
virtual bool addChild (Node *child)
virtual bool insertChild (unsigned int index, Node *child)
bool removeChild (Node *child)
bool removeChild (unsigned int pos, unsigned int numChildrenToRemove=1)
virtual bool removeChildren (unsigned int pos, unsigned int numChildrenToRemove)
virtual bool replaceChild (Node *origChild, Node *newChild)
unsigned int getNumChildren () const
virtual bool setChild (unsigned int i, Node *node)
NodegetChild (unsigned int i)
const NodegetChild (unsigned int i) const
bool containsNode (const Node *node) const
unsigned int getChildIndex (const Node *node) const
virtual void setThreadSafeRefUnref (bool threadSafe)
virtual void resizeGLObjectBuffers (unsigned int maxSize)
virtual void releaseGLObjects (osg::State *=0) const
- Public Member Functions inherited from osg::Node
 Node ()
 Node (const Node &, const CopyOp &copyop=CopyOp::SHALLOW_COPY)
virtual SwitchasSwitch ()
virtual const SwitchasSwitch () const
virtual GeodeasGeode ()
virtual const GeodeasGeode () const
virtual osgTerrain::TerrainasTerrain ()
virtual const osgTerrain::TerrainasTerrain () const
virtual void ascend (NodeVisitor &nv)
const ParentListgetParents () const
ParentList getParents ()
GroupgetParent (unsigned int i)
const GroupgetParent (unsigned int i) const
unsigned int getNumParents () const
NodePathList getParentalNodePaths (osg::Node *haltTraversalAtNode=0) const
MatrixList getWorldMatrices (const osg::Node *haltTraversalAtNode=0) const
void setUpdateCallback (NodeCallback *nc)
NodeCallbackgetUpdateCallback ()
const NodeCallbackgetUpdateCallback () const
void addUpdateCallback (NodeCallback *nc)
void removeUpdateCallback (NodeCallback *nc)
unsigned int getNumChildrenRequiringUpdateTraversal () const
void setEventCallback (NodeCallback *nc)
NodeCallbackgetEventCallback ()
const NodeCallbackgetEventCallback () const
void addEventCallback (NodeCallback *nc)
void removeEventCallback (NodeCallback *nc)
unsigned int getNumChildrenRequiringEventTraversal () const
void setCullCallback (NodeCallback *nc)
NodeCallbackgetCullCallback ()
const NodeCallbackgetCullCallback () const
void addCullCallback (NodeCallback *nc)
void removeCullCallback (NodeCallback *nc)
void setCullingActive (bool active)
bool getCullingActive () const
unsigned int getNumChildrenWithCullingDisabled () const
bool isCullingActive () const
unsigned int getNumChildrenWithOccluderNodes () const
bool containsOccluderNodes () const
void setNodeMask (NodeMask nm)
NodeMask getNodeMask () const
void setStateSet (osg::StateSet *stateset)
osg::StateSetgetOrCreateStateSet ()
osg::StateSetgetStateSet ()
const osg::StateSetgetStateSet () const
void setDescriptions (const DescriptionList &descriptions)
DescriptionListgetDescriptions ()
const DescriptionListgetDescriptions () const
const std::string & getDescription (unsigned int i) const
std::string & getDescription (unsigned int i)
unsigned int getNumDescriptions () const
void addDescription (const std::string &desc)
void setInitialBound (const osg::BoundingSphere &bsphere)
const BoundingSpheregetInitialBound () const
void dirtyBound ()
const BoundingSpheregetBound () const
void setComputeBoundingSphereCallback (ComputeBoundingSphereCallback *callback)
ComputeBoundingSphereCallbackgetComputeBoundingSphereCallback ()
const
ComputeBoundingSphereCallback
getComputeBoundingSphereCallback () const
- Public Member Functions inherited from osg::Object
 Object ()
 Object (bool threadSafeRefUnref)
 Object (const Object &, const CopyOp &copyop=CopyOp::SHALLOW_COPY)
virtual void setName (const std::string &name)
void setName (const char *name)
const std::string & getName () const
void setDataVariance (DataVariance dv)
DataVariance getDataVariance () const
virtual void computeDataVariance ()
void setUserDataContainer (osg::UserDataContainer *udc)
osg::UserDataContainergetUserDataContainer ()
const osg::UserDataContainergetUserDataContainer () const
osg::UserDataContainergetOrCreateUserDataContainer ()
virtual void setUserData (Referenced *obj)
virtual ReferencedgetUserData ()
virtual const ReferencedgetUserData () const
template<typename T >
bool getUserValue (const std::string &name, T &value) const
template<typename T >
void setUserValue (const std::string &name, const T &value)
- Public Member Functions inherited from osg::Referenced
 Referenced ()
 Referenced (bool threadSafeRefUnref)
 Referenced (const Referenced &)
Referencedoperator= (const Referenced &)
bool getThreadSafeRefUnref () const
OpenThreads::MutexgetRefMutex () const
int ref () const
int unref () const
int unref_nodelete () const
int referenceCount () const
ObserverSetgetObserverSet () const
ObserverSetgetOrCreateObserverSet () const
void addObserver (Observer *observer) const
void removeObserver (Observer *observer) const

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 ()
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 ()
- 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

Additional Inherited Members

- Static Public Member Functions inherited from osg::Referenced
static OpenThreads::MutexgetGlobalReferencedMutex ()
static void setThreadSafeReferenceCounting (bool enableThreadSafeReferenceCounting)
static bool getThreadSafeReferenceCounting ()
static void setDeleteHandler (DeleteHandler *handler)
static DeleteHandlergetDeleteHandler ()

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: