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

Simple arrow object node. More...

#include <DAFFVizArrow.h>

Inheritance diagram for DAFFViz::Arrow:
DAFFViz::SGNode

Public Member Functions

 Arrow (DAFFViz::SGNode *pParentNode=NULL, double dTipLength=.15f, double dTipRadius=.06f, int iTipResolution=36, double dShaftRadius=.02f, int iShaftResolution=36)
 Constructor. More...
 
virtual ~Arrow ()
 
double GetTipLength () const
 Tip length getter. More...
 
void SetTipLength (double dLength)
 Tip length setter. More...
 
double GetTipRadius () const
 Tip radius getter. More...
 
void SetTipRadius (double dRadius)
 Tip radius setter. More...
 
int GetTipResolution () const
 Tip resolution getter. More...
 
void SetTipResolution (int iResolution)
 Tip resolution setter. More...
 
double GetShaftRadius () const
 Shaft radius getter. More...
 
void SetShaftRadius (double dRadius)
 Shaft radius setter. More...
 
int GetShaftResolution () const
 Shaft resolution getter. More...
 
void SetShaftResolution (int iResolution)
 Shaft resolution setter. More...
 
void GetColor (double &r, double &g, double &b)
 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...
 
void SetVisible (bool bVisible)
 Set visibility. More...
 
bool IsVisible () const
 Get visibility. 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...
 

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...
 
virtual void OnSetFollowerCamera (vtkSmartPointer< vtkCamera > pCamera)
 Set active camera for followers. More...
 

Detailed Description

Simple arrow object node.

This class derived from the scene graph node class creates an arrow from VTK.

Definition at line 31 of file DAFFVizArrow.h.

Constructor & Destructor Documentation

DAFFViz::Arrow::Arrow ( DAFFViz::SGNode pParentNode = NULL,
double  dTipLength = .15f,
double  dTipRadius = .06f,
int  iTipResolution = 36,
double  dShaftRadius = .02f,
int  iShaftResolution = 36 
)

Constructor.

Creates an arrow pointing aling X axis

Note
Rotate around yaw by +90 to let arrow point to "front" direction at -Z (OpenGL)

Definition at line 12 of file DAFFVizArrow.cpp.

DAFFViz::Arrow::~Arrow ( )
virtual

Definition at line 27 of file DAFFVizArrow.cpp.

Member Function Documentation

double DAFFViz::Arrow::GetAlpha ( ) const

Alpha getter.

Definition at line 105 of file DAFFVizArrow.cpp.

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

Color getter.

Definition at line 101 of file DAFFVizArrow.cpp.

double DAFFViz::Arrow::GetShaftRadius ( ) const

Shaft radius getter.

Definition at line 76 of file DAFFVizArrow.cpp.

int DAFFViz::Arrow::GetShaftResolution ( ) const

Shaft resolution getter.

Definition at line 84 of file DAFFVizArrow.cpp.

double DAFFViz::Arrow::GetTipLength ( ) const

Tip length getter.

Definition at line 51 of file DAFFVizArrow.cpp.

double DAFFViz::Arrow::GetTipRadius ( ) const

Tip radius getter.

Definition at line 60 of file DAFFVizArrow.cpp.

int DAFFViz::Arrow::GetTipResolution ( ) const

Tip resolution getter.

Definition at line 72 of file DAFFVizArrow.cpp.

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

Get visibility.

Reimplemented from DAFFViz::SGNode.

Definition at line 127 of file DAFFVizArrow.cpp.

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

Alpha setter.

Definition at line 109 of file DAFFVizArrow.cpp.

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

Color setter.

Definition at line 95 of file DAFFVizArrow.cpp.

void DAFFViz::Arrow::SetShaftRadius ( double  dRadius)

Shaft radius setter.

Definition at line 80 of file DAFFVizArrow.cpp.

void DAFFViz::Arrow::SetShaftResolution ( int  iResolution)

Shaft resolution setter.

Definition at line 88 of file DAFFVizArrow.cpp.

void DAFFViz::Arrow::SetTipLength ( double  dLength)

Tip length setter.

Definition at line 56 of file DAFFVizArrow.cpp.

void DAFFViz::Arrow::SetTipRadius ( double  dRadius)

Tip radius setter.

Definition at line 64 of file DAFFVizArrow.cpp.

void DAFFViz::Arrow::SetTipResolution ( int  iResolution)

Tip resolution setter.

Definition at line 68 of file DAFFVizArrow.cpp.

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

Set visibility.

Reimplemented from DAFFViz::SGNode.

Definition at line 115 of file DAFFVizArrow.cpp.


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.