MIRA
Public Types | Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
AxesObject Class Reference

#include <visualization/3d/AxesObject.h>

Inheritance diagram for AxesObject:
Inheritance graph
[legend]

Public Types

enum  AxesFlags { NO_AXIS = 0x00, X_AXIS = 0x01, Y_AXIS = 0x02, Z_AXIS = 0x04 }
 

Public Member Functions

 AxesObject (Ogre::SceneManager *sceneManager, Ogre::SceneNode *parent=NULL)
 
virtual ~AxesObject ()
 
float getLength () const
 
void setLength (float length)
 
float getRadius () const
 
void setRadius (float radius)
 
const Ogre::ColourValue & getXAxisColor ()
 
const Ogre::ColourValue & getYAxisColor ()
 
const Ogre::ColourValue & getZAxisColor ()
 
void setColor (const Ogre::ColourValue &xaxis, const Ogre::ColourValue &yaxis, const Ogre::ColourValue &zaxis)
 
void setColor (const Ogre::ColourValue &uniform)
 
bool isShowingXAxis () const
 
void showXAxis (bool show)
 
bool isShowingYAxis () const
 
void showYAxis (bool show)
 
bool isShowingZAxis () const
 
void showZAxis (bool show)
 
bool isShowingArrows () const
 
void showArrows (bool show)
 
float getAlpha () const
 
void setAlpha (float alpha)
 
bool isVisible () const
 
virtual void setVisible (bool visible, bool cascade=true)
 
virtual void setScale (const Ogre::Vector3 &scale)
 
virtual void setScale (const Eigen::Vector3f &scale)
 
virtual void setPosition (const Ogre::Vector3 &position)
 
virtual void setPosition (const Eigen::Vector3f &position)
 
virtual void setOrientation (const Ogre::Quaternion &orientation)
 
virtual void setOrientation (const Eigen::Quaternionf &orientation)
 
virtual void setColor (Color::RGBA color)
 
virtual void setTransform (const RigidTransform2f &transform)
 
virtual void setTransform (const RigidTransform3f &transform)
 
Ogre::SceneNode * getNode ()
 

Protected Member Functions

void updateVisibility ()
 
void updateScales ()
 
void updateColor ()
 

Protected Attributes

bool mVisible
 
bool mShowXAxis
 
bool mShowYAxis
 
bool mShowZAxis
 
bool mShowArrows
 
float mAxisLength
 
float mAxisRadius
 
ArrowObjectmXAxis
 
ArrowObjectmYAxis
 
ArrowObjectmZAxis
 
Ogre::ColourValue mXAxisColor
 
Ogre::ColourValue mYAxisColor
 
Ogre::ColourValue mZAxisColor
 
Ogre::SceneManager * mSceneManager
 
Ogre::SceneNode * mNode
 

Member Enumeration Documentation

◆ AxesFlags

enum AxesFlags
Enumerator
NO_AXIS 
X_AXIS 
Y_AXIS 
Z_AXIS 

Constructor & Destructor Documentation

◆ AxesObject()

AxesObject ( Ogre::SceneManager *  sceneManager,
Ogre::SceneNode *  parent = NULL 
)

◆ ~AxesObject()

virtual ~AxesObject ( )
virtual

Member Function Documentation

◆ getLength()

float getLength ( ) const
inline

◆ setLength()

void setLength ( float  length)

◆ getRadius()

float getRadius ( ) const
inline

◆ setRadius()

void setRadius ( float  radius)

◆ getXAxisColor()

const Ogre::ColourValue& getXAxisColor ( )
inline

◆ getYAxisColor()

const Ogre::ColourValue& getYAxisColor ( )
inline

◆ getZAxisColor()

const Ogre::ColourValue& getZAxisColor ( )
inline

◆ setColor() [1/3]

void setColor ( const Ogre::ColourValue &  xaxis,
const Ogre::ColourValue &  yaxis,
const Ogre::ColourValue &  zaxis 
)

◆ setColor() [2/3]

void setColor ( const Ogre::ColourValue &  uniform)
virtual

Reimplemented from VisualizationObject.

◆ isShowingXAxis()

bool isShowingXAxis ( ) const
inline

◆ showXAxis()

void showXAxis ( bool  show)

◆ isShowingYAxis()

bool isShowingYAxis ( ) const
inline

◆ showYAxis()

void showYAxis ( bool  show)

◆ isShowingZAxis()

bool isShowingZAxis ( ) const
inline

◆ showZAxis()

void showZAxis ( bool  show)

◆ isShowingArrows()

bool isShowingArrows ( ) const
inline

◆ showArrows()

void showArrows ( bool  show)

◆ getAlpha()

float getAlpha ( ) const
inline

◆ setAlpha()

void setAlpha ( float  alpha)

◆ isVisible()

bool isVisible ( ) const
inline

◆ setVisible()

virtual void setVisible ( bool  visible,
bool  cascade = true 
)
virtual

Reimplemented from VisualizationObject.

◆ updateVisibility()

void updateVisibility ( )
protected

◆ updateScales()

void updateScales ( )
protected

◆ updateColor()

void updateColor ( )
protected

◆ setScale() [1/2]

virtual void setScale ( const Ogre::Vector3 &  scale)
virtualinherited

◆ setScale() [2/2]

virtual void setScale ( const Eigen::Vector3f &  scale)
virtualinherited

◆ setPosition() [1/2]

virtual void setPosition ( const Ogre::Vector3 &  position)
virtualinherited

◆ setPosition() [2/2]

virtual void setPosition ( const Eigen::Vector3f &  position)
virtualinherited

◆ setOrientation() [1/2]

virtual void setOrientation ( const Ogre::Quaternion &  orientation)
virtualinherited

◆ setOrientation() [2/2]

virtual void setOrientation ( const Eigen::Quaternionf orientation)
virtualinherited

◆ setColor() [3/3]

virtual void setColor ( Color::RGBA  color)
inlinevirtualinherited

◆ setTransform() [1/2]

virtual void setTransform ( const RigidTransform2f transform)
virtualinherited

◆ setTransform() [2/2]

virtual void setTransform ( const RigidTransform3f transform)
virtualinherited

◆ getNode()

Ogre::SceneNode* getNode ( )
inlineinherited

Member Data Documentation

◆ mVisible

bool mVisible
protected

◆ mShowXAxis

bool mShowXAxis
protected

◆ mShowYAxis

bool mShowYAxis
protected

◆ mShowZAxis

bool mShowZAxis
protected

◆ mShowArrows

bool mShowArrows
protected

◆ mAxisLength

float mAxisLength
protected

◆ mAxisRadius

float mAxisRadius
protected

◆ mXAxis

ArrowObject* mXAxis
protected

◆ mYAxis

ArrowObject* mYAxis
protected

◆ mZAxis

ArrowObject* mZAxis
protected

◆ mXAxisColor

Ogre::ColourValue mXAxisColor
protected

◆ mYAxisColor

Ogre::ColourValue mYAxisColor
protected

◆ mZAxisColor

Ogre::ColourValue mZAxisColor
protected

◆ mSceneManager

Ogre::SceneManager* mSceneManager
protectedinherited

◆ mNode

Ogre::SceneNode* mNode
protectedinherited

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