OpenDAFF C++ API  v1.7
Directional Audio File Format
Public Member Functions | Friends | List of all members
DAFFViz::Label Class Reference

Simple arrow object node. More...

#include <DAFFVizLabel.h>

Inheritance diagram for DAFFViz::Label:
DAFFViz::SGNode

Public Member Functions

 Label ()
 
 Label (SGNode *pNode)
 
 Label (SGNode *pNode, std::string sText)
 
 ~Label ()
 
void GetColor (double &r, double &g, double &b) const
 Color getter. More...
 
void SetColor (double r, double g, double b)
 Color setter. More...
 
double GetAlpha () const
 Alpha getter. More...
 
void SetAlpha (double a)
 Alpha setter. More...
 
bool IsVisible () const
 Get visibility. More...
 
void SetVisible (bool bVisible)
 Set visibility. More...
 
void SetText (const std::string &sText)
 Label text setter. More...
 
std::string GetText () const
 Label text getter. More...
 
- Public Member Functions inherited from DAFFViz::SGNode
 SGNode (DAFFViz::SGNode *pParentNode=NULL)
 Constructor with optional linking to a parent node. More...
 
virtual ~SGNode ()
 Destructor. More...
 
DAFFViz::SGNodeGetRootNode () const
 Traverses up to the root (recursively) and returns the node pointer. More...
 
DAFFViz::SGNodeGetParentNode () const
 Returns the parent node pointer. More...
 
bool HasParentNode () const
 Returns true if the node is appended to a parent node. More...
 
bool IsRoot () const
 Returns true if the node is a root node (... has no parent node) More...
 
bool HasChildNodes () const
 Returns true if the node combines one or more child nodes. More...
 
bool IsLeaf () const
 Returns true if the node appears as a leaf node (... has no child nodes) More...
 
const DAFFViz::SGNodeGetChildNode (int iIndex) const
 Returns the pointer to the child node of given index (for const correctness) More...
 
DAFFViz::SGNodeGetChildNode (int iIndex)
 Returns the pointer to the child node of given index. More...
 
void GetChildNodes (std::vector< const DAFFViz::SGNode * > &vpChildren) const
 Returns all the pointers to the child nodes (for const correctness, clears vector if no childs available) More...
 
void GetChildNodes (std::vector< DAFFViz::SGNode * > &vpChildren)
 Returns all the pointers to the child nodes (clears vector if no childs available) More...
 
bool AddChildNode (DAFFViz::SGNode *pChild)
 Appends a single child node. More...
 
bool AddChildNodes (const std::vector< DAFFViz::SGNode * > &vpChildren)
 Appends a vector child nodes. More...
 
bool RemoveChildNode (DAFFViz::SGNode *pChild)
 Removes a single child node. More...
 
bool RemoveChildNodes (const std::vector< DAFFViz::SGNode * > &vpChildren)
 Removes a vector of child nodes. More...
 
void GetPosition (double &x, double &y, double &z) const
 Position setter (unit is meter) More...
 
void SetPosition (double x, double y, double z)
 Position getter (unit is meter) More...
 
void GetOrientation (double &dRotXDeg, double &dRotYDeg, double &dRotZDeg) const
 Orientation getter (angles in [°]) More...
 
void SetOrientation (double dRotXDeg, double dRotYDeg, double dRotZDeg)
 Sets the orientation of the node assembly based on world coordinate axis (angles in [°]) More...
 
void SetOrientationYPR (double dYawDeg, double dPitchDeg, double dRollDeg)
 Sets the orientation of the node assembly based on yaw, pitch and roll angles around own coordinate axis (angles in [°]) More...
 
void GetOrientationYPR (double &dYawDeg, double &dPitchDeg, double &dRollDeg)
 Orientation getter of the node assembly based on yaw, pitch and roll angles around own coordinate axis (angles in [°]) More...
 
void SetOrientationVU (double vx, double vy, double vz, double ux, double uy, double uz)
 Sets the orientation of the node assembly based on view- and up-vectors. More...
 
void GetOrientationVU (double &vx, double &vy, double &vz, double &ux, double &uy, double &uz)
 Returns the orientation of the node assembly based on view- and up-vectors. More...
 
void GetScale (double &sx, double &sy, double &sz) const
 Scale getter. More...
 
void SetScale (double sx, double sy, double sz)
 Scale setter. More...
 

Friends

class Frame
 

Additional Inherited Members

- Protected Member Functions inherited from DAFFViz::SGNode
void AddActor (vtkSmartPointer< vtkActor > pActor)
 Add a VTK actor to the node. More...
 
void RemoveActor (vtkSmartPointer< vtkActor > pActor)
 Remove a VTK actor from the assembly of the node. More...
 
void AddAssembly (vtkSmartPointer< vtkAssembly > pAssembly)
 Add a VTK assembly to the node. More...
 
void RemoveAssembly (vtkSmartPointer< vtkAssembly > pAssembly)
 Release an assembly from the assembly of the node. More...
 

Detailed Description

Simple arrow object node.

This class derived from the scene graph node class creates a text label from VTK.

Definition at line 33 of file DAFFVizLabel.h.

Constructor & Destructor Documentation

DAFFViz::Label::Label ( )

Definition at line 14 of file DAFFVizLabel.cpp.

DAFFViz::Label::Label ( SGNode pNode)

Definition at line 21 of file DAFFVizLabel.cpp.

DAFFViz::Label::Label ( SGNode pNode,
std::string  sText 
)

Definition at line 28 of file DAFFVizLabel.cpp.

DAFFViz::Label::~Label ( )

Definition at line 36 of file DAFFVizLabel.cpp.

Member Function Documentation

double DAFFViz::Label::GetAlpha ( ) const

Alpha getter.

Definition at line 71 of file DAFFVizLabel.cpp.

void DAFFViz::Label::GetColor ( double &  r,
double &  g,
double &  b 
) const

Color getter.

Definition at line 59 of file DAFFVizLabel.cpp.

std::string DAFFViz::Label::GetText ( ) const

Label text getter.

bool DAFFViz::Label::IsVisible ( ) const
virtual

Get visibility.

Reimplemented from DAFFViz::SGNode.

Definition at line 95 of file DAFFVizLabel.cpp.

void DAFFViz::Label::SetAlpha ( double  a)

Alpha setter.

Definition at line 76 of file DAFFVizLabel.cpp.

void DAFFViz::Label::SetColor ( double  r,
double  g,
double  b 
)

Color setter.

Definition at line 64 of file DAFFVizLabel.cpp.

void DAFFViz::Label::SetText ( const std::string &  sText)

Label text setter.

Definition at line 103 of file DAFFVizLabel.cpp.

void DAFFViz::Label::SetVisible ( bool  bVisible)
virtual

Set visibility.

Reimplemented from DAFFViz::SGNode.

Definition at line 83 of file DAFFVizLabel.cpp.

Friends And Related Function Documentation

friend class Frame
friend

Definition at line 86 of file DAFFVizLabel.h.


The documentation for this class was generated from the following files:
OpenDAFF is a project from the Institute of Technical Acoustics, RWTH Aachen University, Germany.