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

Simple plane object node [TODO Jonas!!]. More...

#include <DAFFVizPlane.h>

Inheritance diagram for DAFFViz::Plane:
DAFFViz::SGNode

Public Member Functions

 Plane (SGNode *pParentNode=NULL)
 
 Plane (double x1, double y1, double z1, double x2, double y2, double z2, double n1, double n2, double n3)
 
 Plane (DAFFViz::SGNode *pParentNode, double x1, double y1, double z1, double x2, double y2, double z2, double n1, double n2, double n3)
 
 ~Plane ()
 
void GetColor (double &r, double &g, double &b)
 Color getter. More...
 
void SetColor (const double r, const double g, const double b)
 Color setter. More...
 
double GetAlpha () const
 Alpha getter. More...
 
void SetAlpha (const double a)
 Alpha setter. More...
 
void SetVisible (bool bVisible)
 Visibility setter. More...
 
bool IsVisible () const
 Visibility 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...
 

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 plane object node [TODO Jonas!!].

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

Definition at line 30 of file DAFFVizPlane.h.

Constructor & Destructor Documentation

DAFFViz::Plane::Plane ( SGNode pParentNode = NULL)

Definition at line 12 of file DAFFVizPlane.cpp.

DAFFViz::Plane::Plane ( double  x1,
double  y1,
double  z1,
double  x2,
double  y2,
double  z2,
double  n1,
double  n2,
double  n3 
)
DAFFViz::Plane::Plane ( DAFFViz::SGNode pParentNode,
double  x1,
double  y1,
double  z1,
double  x2,
double  y2,
double  z2,
double  n1,
double  n2,
double  n3 
)

Definition at line 21 of file DAFFVizPlane.cpp.

DAFFViz::Plane::~Plane ( )

Definition at line 33 of file DAFFVizPlane.cpp.

Member Function Documentation

double DAFFViz::Plane::GetAlpha ( ) const

Alpha getter.

Definition at line 68 of file DAFFVizPlane.cpp.

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

Color getter.

Definition at line 63 of file DAFFVizPlane.cpp.

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

Visibility getter.

Reimplemented from DAFFViz::SGNode.

Definition at line 80 of file DAFFVizPlane.cpp.

void DAFFViz::Plane::SetAlpha ( const double  a)

Alpha setter.

Definition at line 73 of file DAFFVizPlane.cpp.

void DAFFViz::Plane::SetColor ( const double  r,
const double  g,
const double  b 
)

Color setter.

Definition at line 56 of file DAFFVizPlane.cpp.

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

Visibility setter.

Reimplemented from DAFFViz::SGNode.

Definition at line 85 of file DAFFVizPlane.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.