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

Simple directivity object node. More...

#include <DAFFVizBalloonPlot.h>

Inheritance diagram for DAFFViz::BalloonPlot:
DAFFViz::SGNode

Public Types

enum  { SCALING_LINEAR =0, SCALING_DECIBEL }
 
enum  { MODE_SURFACE =0, MODE_WIREFRAME, MODE_POINT }
 

Public Member Functions

 BalloonPlot (SGNode *pParentNode, const DAFFContent *pContent)
 
 BalloonPlot (const DAFFContent *pContent)
 
virtual ~BalloonPlot ()
 
int GetSelectedFrequency () const
 Returns the currently selected frequency index. More...
 
void SetSelectedFrequency (int iFreqIndex)
 Sets the currently selected frequency index. More...
 
int GetScaling () const
 Get scaling (SCALING_LINEAR | SCALING_DECIBEL) More...
 
void SetScaling (int iScaling)
 Set scaling (SCALING_LINEAR | SCALING_DECIBEL) More...
 
double GetRangeMin () const
 Set minimum of data range (in dB or absolute values depending on currently used scaling) More...
 
double GetRangeMax () const
 Set minimum of data range (in dB or absolute values depending on currently used scaling) More...
 
void SetRange (double dMin, double dMax)
 Set data range (in dB or absolute values depending on currently used scaling) More...
 
void SetUseCustomRange (bool bChecked)
 set wether the magnitudes should be normalized to a custom range More...
 
void SetScalarVisibility (bool bVisible)
 Set whether scalars should be used to color the model. More...
 
int GetScalarVisibility ()
 Get whether scalars should be used to color the model. More...
 
void SetDisplayMode (int iMode)
 Set display mode (MODE_SURFACE | MODE_WIREFRAME | MODE_POINT) More...
 
void SetChannel (int iChannel)
 Set active channel. More...
 
int GetChannel ()
 get active channel More...
 
void EnableWarp ()
 Enable/Disable warping (WARP_DISABLE | WARP_ENABLE) More...
 
void DisableWarp ()
 
void SetNormalize (bool bChecked)
 set wether the magnitudes should be normalized More...
 
void SetNormalizeFrequenciesIndividually (bool bChecked)
 set wether the magnitudes should be normalized for each individual frequency More...
 
void SetUsePhaseAsColor (bool bUse)
 set whether the phase should be used for coloring. If not, the magnitude will be used. More...
 
void SetProbeAngles (double dAlpha, double dBeta)
 Set probe angles. More...
 
void SetProbeVisible (bool bVisible)
 Enables/disables probe. More...
 
void UpdateProbe ()
 Update probe nodes. 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...
 
virtual void SetVisible (bool bVisible)
 Set visibility. More...
 
virtual bool IsVisible () const
 Returns true if the node is visible. 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 directivity object node.

This class derived from the scene graph node class creates a directivity.

Definition at line 37 of file DAFFVizBalloonPlot.h.

Member Enumeration Documentation

anonymous enum
Enumerator
SCALING_LINEAR 
SCALING_DECIBEL 

Definition at line 40 of file DAFFVizBalloonPlot.h.

anonymous enum
Enumerator
MODE_SURFACE 
MODE_WIREFRAME 
MODE_POINT 

Definition at line 46 of file DAFFVizBalloonPlot.h.

Constructor & Destructor Documentation

DAFFViz::BalloonPlot::BalloonPlot ( SGNode pParentNode,
const DAFFContent pContent 
)

Definition at line 39 of file DAFFVizBalloonPlot.cpp.

DAFFViz::BalloonPlot::BalloonPlot ( const DAFFContent pContent)

Definition at line 56 of file DAFFVizBalloonPlot.cpp.

DAFFViz::BalloonPlot::~BalloonPlot ( )
virtual

Definition at line 73 of file DAFFVizBalloonPlot.cpp.

Member Function Documentation

void DAFFViz::BalloonPlot::DisableWarp ( )

Definition at line 558 of file DAFFVizBalloonPlot.cpp.

void DAFFViz::BalloonPlot::EnableWarp ( )

Enable/Disable warping (WARP_DISABLE | WARP_ENABLE)

Definition at line 551 of file DAFFVizBalloonPlot.cpp.

int DAFFViz::BalloonPlot::GetChannel ( )

get active channel

Definition at line 880 of file DAFFVizBalloonPlot.cpp.

double DAFFViz::BalloonPlot::GetRangeMax ( ) const

Set minimum of data range (in dB or absolute values depending on currently used scaling)

Definition at line 542 of file DAFFVizBalloonPlot.cpp.

double DAFFViz::BalloonPlot::GetRangeMin ( ) const

Set minimum of data range (in dB or absolute values depending on currently used scaling)

Definition at line 530 of file DAFFVizBalloonPlot.cpp.

int DAFFViz::BalloonPlot::GetScalarVisibility ( )

Get whether scalars should be used to color the model.

Definition at line 859 of file DAFFVizBalloonPlot.cpp.

int DAFFViz::BalloonPlot::GetScaling ( ) const

Get scaling (SCALING_LINEAR | SCALING_DECIBEL)

Definition at line 502 of file DAFFVizBalloonPlot.cpp.

int DAFFViz::BalloonPlot::GetSelectedFrequency ( ) const

Returns the currently selected frequency index.

Definition at line 489 of file DAFFVizBalloonPlot.cpp.

void DAFFViz::BalloonPlot::SetChannel ( int  iChannel)

Set active channel.

Definition at line 874 of file DAFFVizBalloonPlot.cpp.

void DAFFViz::BalloonPlot::SetDisplayMode ( int  iMode)

Set display mode (MODE_SURFACE | MODE_WIREFRAME | MODE_POINT)

Definition at line 864 of file DAFFVizBalloonPlot.cpp.

void DAFFViz::BalloonPlot::SetNormalize ( bool  bChecked)

set wether the magnitudes should be normalized

Definition at line 565 of file DAFFVizBalloonPlot.cpp.

void DAFFViz::BalloonPlot::SetNormalizeFrequenciesIndividually ( bool  bChecked)

set wether the magnitudes should be normalized for each individual frequency

Definition at line 571 of file DAFFVizBalloonPlot.cpp.

void DAFFViz::BalloonPlot::SetProbeAngles ( double  dAlpha,
double  dBeta 
)

Set probe angles.

Definition at line 469 of file DAFFVizBalloonPlot.cpp.

void DAFFViz::BalloonPlot::SetProbeVisible ( bool  bVisible)

Enables/disables probe.

Definition at line 475 of file DAFFVizBalloonPlot.cpp.

void DAFFViz::BalloonPlot::SetRange ( double  dMin,
double  dMax 
)

Set data range (in dB or absolute values depending on currently used scaling)

Definition at line 507 of file DAFFVizBalloonPlot.cpp.

void DAFFViz::BalloonPlot::SetScalarVisibility ( bool  bVisible)

Set whether scalars should be used to color the model.

Definition at line 854 of file DAFFVizBalloonPlot.cpp.

void DAFFViz::BalloonPlot::SetScaling ( int  iScaling)

Set scaling (SCALING_LINEAR | SCALING_DECIBEL)

Definition at line 494 of file DAFFVizBalloonPlot.cpp.

void DAFFViz::BalloonPlot::SetSelectedFrequency ( int  iFreqIndex)

Sets the currently selected frequency index.

Definition at line 481 of file DAFFVizBalloonPlot.cpp.

void DAFFViz::BalloonPlot::SetUseCustomRange ( bool  bChecked)

set wether the magnitudes should be normalized to a custom range

Definition at line 524 of file DAFFVizBalloonPlot.cpp.

void DAFFViz::BalloonPlot::SetUsePhaseAsColor ( bool  bUse)

set whether the phase should be used for coloring. If not, the magnitude will be used.

Definition at line 885 of file DAFFVizBalloonPlot.cpp.

void DAFFViz::BalloonPlot::UpdateProbe ( )

Update probe nodes.

Definition at line 312 of file DAFFVizBalloonPlot.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.