openscenegraph
Public Types | Public Member Functions | Protected Types | Protected Member Functions | Protected Attributes | List of all members
osg::AutoTransform Class Reference

#include <AutoTransform>

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 Types inherited from osg::Node
typedef std::vector< Group * > ParentList
 
typedef unsigned int NodeMask
 
typedef std::vector< std::string > DescriptionList
 
- Public Types inherited from osg::Object
enum  DataVariance { DYNAMIC , STATIC , UNSPECIFIED }
 

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 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
 
- 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 PositionAttitudeTransformasPositionAttitudeTransform () const
 
void setReferenceFrame (ReferenceFrame rf)
 
ReferenceFrame getReferenceFrame () const
 
virtual BoundingSphere computeBound () 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)
 
template<class T >
bool addChild (const ref_ptr< T > &child)
 
virtual bool insertChild (unsigned int index, Node *child)
 
template<class T >
bool insertChild (unsigned int index, const ref_ptr< T > &child)
 
virtual bool removeChild (Node *child)
 
template<class T >
bool removeChild (const ref_ptr< T > &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)
 
template<class T , class R >
bool replaceChild (const ref_ptr< T > &origChild, const ref_ptr< R > &newChild)
 
virtual 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
 
template<class T >
bool containsNode (const ref_ptr< T > &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 NodeasNode ()
 
virtual const NodeasNode () const
 
virtual DrawableasDrawable ()
 
virtual const DrawableasDrawable () const
 
virtual GeometryasGeometry ()
 
virtual const GeometryasGeometry () const
 
virtual SwitchasSwitch ()
 
virtual const SwitchasSwitch () const
 
virtual GeodeasGeode ()
 
virtual const GeodeasGeode () const
 
virtual osgTerrain::TerrainasTerrain ()
 
virtual const osgTerrain::TerrainasTerrain () const
 
virtual void accept (NodeVisitor &nv)
 
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 (Callback *nc)
 
template<class T >
void setUpdateCallback (const ref_ptr< T > &nc)
 
CallbackgetUpdateCallback ()
 
const CallbackgetUpdateCallback () const
 
void addUpdateCallback (Callback *nc)
 
template<class T >
void addUpdateCallback (const ref_ptr< T > &nc)
 
void removeUpdateCallback (Callback *nc)
 
template<class T >
void removeUpdateCallback (const ref_ptr< T > &nc)
 
unsigned int getNumChildrenRequiringUpdateTraversal () const
 
void setEventCallback (Callback *nc)
 
template<class T >
void setEventCallback (const ref_ptr< T > &nc)
 
CallbackgetEventCallback ()
 
const CallbackgetEventCallback () const
 
void addEventCallback (Callback *nc)
 
template<class T >
void addEventCallback (const ref_ptr< T > &nc)
 
void removeEventCallback (Callback *nc)
 
template<class T >
void removeEventCallback (const ref_ptr< T > &nc)
 
unsigned int getNumChildrenRequiringEventTraversal () const
 
void setCullCallback (Callback *nc)
 
template<class T >
void setCullCallback (const ref_ptr< T > &nc)
 
CallbackgetCullCallback ()
 
const CallbackgetCullCallback () const
 
void addCullCallback (Callback *nc)
 
template<class T >
void addCullCallback (const ref_ptr< T > &nc)
 
void removeCullCallback (Callback *nc)
 
template<class T >
void removeCullCallback (const ref_ptr< T > &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)
 
template<class T >
void setStateSet (const osg::ref_ptr< T > &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)
 
template<class T >
void setComputeBoundingSphereCallback (const ref_ptr< T > &callback)
 
ComputeBoundingSphereCallbackgetComputeBoundingSphereCallback ()
 
const ComputeBoundingSphereCallbackgetComputeBoundingSphereCallback () const
 
- Public Member Functions inherited from osg::Object
 Object ()
 
 Object (bool threadSafeRefUnref)
 
 Object (const Object &, const CopyOp &copyop=CopyOp::SHALLOW_COPY)
 
std::string getCompoundClassName () const
 
virtual NodeVisitorasNodeVisitor ()
 
virtual const NodeVisitorasNodeVisitor () const
 
virtual StateSetasStateSet ()
 
virtual const StateSetasStateSet () const
 
virtual StateAttributeasStateAttribute ()
 
virtual const StateAttributeasStateAttribute () const
 
virtual UniformasUniform ()
 
virtual const UniformasUniform () const
 
virtual CameraasCamera ()
 
virtual const CameraasCamera () const
 
virtual CallbackasCallback ()
 
virtual const CallbackasCallback () const
 
virtual CallbackObjectasCallbackObject ()
 
virtual const CallbackObjectasCallbackObject () const
 
virtual UserDataContainerasUserDataContainer ()
 
virtual const UserDataContainerasUserDataContainer () const
 
virtual ValueObjectasValueObject ()
 
virtual const ValueObjectasValueObject () const
 
virtual ImageasImage ()
 
virtual const ImageasImage () const
 
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)
 
template<class T >
void setUserDataContainer (const ref_ptr< T > &udc)
 
osg::UserDataContainergetUserDataContainer ()
 
const osg::UserDataContainergetUserDataContainer () const
 
osg::UserDataContainergetOrCreateUserDataContainer ()
 
virtual void setUserData (Referenced *obj)
 
template<class T >
void setUserData (const ref_ptr< T > &ud)
 
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)
 
template<typename T >
BoolValueObject UCharValueObject UShortValueObject UIntValueObject DoubleValueObject Vec3fValueObject Vec2dValueObject Vec4dValueObject PlaneValueObject MatrixdValueObject BoundingBoxdValueObject BoundingSpheredValueObject bool getUserValue (const std::string &name, T &value) const
 
- 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 ()
 
osg::Matrixd computeMatrix (const osg::NodeVisitor *nv) 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 *parent)
 
void removeParent (osg::Group *parent)
 
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
 
double _minimumScale
 
double _maximumScale
 
double _autoScaleTransitionWidthRatio
 
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< Callback_updateCallback
 
unsigned int _numChildrenRequiringUpdateTraversal
 
ref_ptr< Callback_eventCallback
 
unsigned int _numChildrenRequiringEventTraversal
 
ref_ptr< Callback_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 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

◆ AutoRotateMode

Enumerator
NO_ROTATION 
ROTATE_TO_SCREEN 
ROTATE_TO_CAMERA 
ROTATE_TO_AXIS 

◆ AxisAligned

Enumerator
AXIAL_ROT_X_AXIS 
AXIAL_ROT_Y_AXIS 
AXIAL_ROT_Z_AXIS 
CACHE_DIRTY 

Constructor & Destructor Documentation

◆ AutoTransform() [1/2]

osg::AutoTransform::AutoTransform ( )

◆ AutoTransform() [2/2]

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

◆ ~AutoTransform()

virtual osg::AutoTransform::~AutoTransform ( )
inlineprotectedvirtual

Member Function Documentation

◆ asAutoTransform() [1/2]

virtual AutoTransform * osg::AutoTransform::asAutoTransform ( )
inlinevirtual

Reimplemented from osg::Transform.

◆ asAutoTransform() [2/2]

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

Reimplemented from osg::Transform.

◆ className()

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

return the name of the node's class type.

Reimplemented from osg::Node.

◆ clone()

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.

◆ cloneType()

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

clone an object of the same type as the node.

Reimplemented from osg::Node.

◆ computeLocalToWorldMatrix()

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

Reimplemented from osg::Transform.

◆ computeMatrix()

osg::Matrixd osg::AutoTransform::computeMatrix ( const osg::NodeVisitor nv) const
protected

◆ computeWorldToLocalMatrix()

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

Reimplemented from osg::Transform.

◆ getAutoRotateMode()

AutoRotateMode osg::AutoTransform::getAutoRotateMode ( ) const
inline

◆ getAutoScaleToScreen()

bool osg::AutoTransform::getAutoScaleToScreen ( ) const
inline

◆ getAutoScaleTransitionWidthRatio()

float osg::AutoTransform::getAutoScaleTransitionWidthRatio ( ) const
inline

◆ getAutoUpdateEyeMovementTolerance()

float osg::AutoTransform::getAutoUpdateEyeMovementTolerance ( ) const
inline

◆ getAxis()

const Vec3 & osg::AutoTransform::getAxis ( ) const
inline

Get the rotation axis.

◆ getMaximumScale()

double osg::AutoTransform::getMaximumScale ( ) const
inline

◆ getMinimumScale()

double osg::AutoTransform::getMinimumScale ( ) const
inline

◆ getNormal()

const Vec3 & osg::AutoTransform::getNormal ( ) const
inline

Get the front face direction normal.

◆ getPivotPoint()

const Vec3d & osg::AutoTransform::getPivotPoint ( ) const
inline

◆ getPosition()

const Vec3d & osg::AutoTransform::getPosition ( ) const
inline

◆ getRotation()

const Quat & osg::AutoTransform::getRotation ( ) const
inline

◆ getScale()

const Vec3d & osg::AutoTransform::getScale ( ) const
inline

◆ isSameKindAs()

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.

◆ libraryName()

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

return the name of the node's library.

Reimplemented from osg::Node.

◆ setAutoRotateMode()

void osg::AutoTransform::setAutoRotateMode ( AutoRotateMode  mode)

◆ setAutoScaleToScreen()

void osg::AutoTransform::setAutoScaleToScreen ( bool  autoScaleToScreen)

◆ setAutoScaleTransitionWidthRatio()

void osg::AutoTransform::setAutoScaleTransitionWidthRatio ( float  ratio)
inline

◆ setAutoUpdateEyeMovementTolerance()

void osg::AutoTransform::setAutoUpdateEyeMovementTolerance ( float  tolerance)
inline

◆ setAxis()

void osg::AutoTransform::setAxis ( const Vec3 axis)

Set the rotation axis for the AutoTransform's child nodes. Only utilized when _autoRotateMode==ROTATE_TO_AXIS.

◆ setMaximumScale()

void osg::AutoTransform::setMaximumScale ( double  maximumScale)
inline

◆ setMinimumScale()

void osg::AutoTransform::setMinimumScale ( double  minimumScale)
inline

◆ setNormal()

void osg::AutoTransform::setNormal ( const Vec3 normal)

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

◆ setPivotPoint()

void osg::AutoTransform::setPivotPoint ( const Vec3d pivot)
inline

◆ setPosition()

void osg::AutoTransform::setPosition ( const Vec3d pos)
inline

◆ setRotation()

void osg::AutoTransform::setRotation ( const Quat quat)
inline

◆ setScale() [1/2]

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

◆ setScale() [2/2]

void osg::AutoTransform::setScale ( double  scale)
inline

◆ updateCache()

void osg::AutoTransform::updateCache ( )
protected

Member Data Documentation

◆ _autoRotateMode

AutoRotateMode osg::AutoTransform::_autoRotateMode
protected

◆ _autoScaleToScreen

bool osg::AutoTransform::_autoScaleToScreen
protected

◆ _autoScaleTransitionWidthRatio

double osg::AutoTransform::_autoScaleTransitionWidthRatio
protected

◆ _autoUpdateEyeMovementTolerance

double osg::AutoTransform::_autoUpdateEyeMovementTolerance
protected

◆ _axis

Vec3 osg::AutoTransform::_axis
protected

◆ _cachedMode

int osg::AutoTransform::_cachedMode
protected

◆ _maximumScale

double osg::AutoTransform::_maximumScale
protected

◆ _minimumScale

double osg::AutoTransform::_minimumScale
protected

◆ _normal

Vec3 osg::AutoTransform::_normal
protected

◆ _pivotPoint

Vec3d osg::AutoTransform::_pivotPoint
protected

◆ _position

Vec3d osg::AutoTransform::_position
protected

◆ _rotation

Quat osg::AutoTransform::_rotation
mutableprotected

◆ _scale

Vec3d osg::AutoTransform::_scale
mutableprotected

◆ _side

Vec3 osg::AutoTransform::_side
protected

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