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

Simple carpet plot object node. More...

#include <DAFFVizCarpetPlot.h>

Inheritance diagram for DAFFViz::CarpetPlot:
DAFFViz::SGNode

Public Types

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

Public Member Functions

 CarpetPlot (SGNode *pParent, const DAFFContentIR *pContentIR)
 
 CarpetPlot (const DAFFContentIR *pContentIR)
 
virtual ~CarpetPlot ()
 
float GetSelectedAngle () const
 Returns the currently selected angle in degree (interval [-90° 90°]) More...
 
void SetSelectedAngle (float fAngle)
 Sets the currently selected angle in degree. More...
 
int GetScaling () const
 Get scaling (SCALING_LINEAR | SCALING_DECIBEL) More...
 
void SetScaling (int iScaling)
 Set scaling (SCALING_LINEAR | SCALING_DECIBEL) More...
 
void SetFixedAngle (int iFixedAngle)
 Set fixed angle (ALPHA_FIXED | BETA_FIXED) More...
 
int getFixedAngle ()
 Get fixed angle (ALPHA_FIXED | BETA_FIXED) 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...
 
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 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 SetWarpingEnabled (bool bEnabled)
 
void GtWarpingEnabled (bool) const
 
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 carpet plot object node.

This class derived from the scene graph node class creates a carpet plot visualization.

Definition at line 34 of file DAFFVizCarpetPlot.h.

Member Enumeration Documentation

anonymous enum
Enumerator
SCALING_LINEAR 
SCALING_DECIBEL 

Definition at line 37 of file DAFFVizCarpetPlot.h.

anonymous enum
Enumerator
BETA_FIXED 
ALPHA_FIXED 

Definition at line 43 of file DAFFVizCarpetPlot.h.

anonymous enum
Enumerator
MODE_SURFACE 
MODE_WIREFRAME 
MODE_POINT 

Definition at line 49 of file DAFFVizCarpetPlot.h.

Constructor & Destructor Documentation

DAFFViz::CarpetPlot::CarpetPlot ( SGNode pParent,
const DAFFContentIR pContentIR 
)

Definition at line 58 of file DAFFVizCarpetPlot.cpp.

DAFFViz::CarpetPlot::CarpetPlot ( const DAFFContentIR pContentIR)

Definition at line 36 of file DAFFVizCarpetPlot.cpp.

DAFFViz::CarpetPlot::~CarpetPlot ( )
virtual

Definition at line 177 of file DAFFVizCarpetPlot.cpp.

Member Function Documentation

void DAFFViz::CarpetPlot::DisableWarp ( )

Definition at line 396 of file DAFFVizCarpetPlot.cpp.

void DAFFViz::CarpetPlot::EnableWarp ( )

Enable/Disable warping (WARP_DISABLE | WARP_ENABLE)

Definition at line 391 of file DAFFVizCarpetPlot.cpp.

int DAFFViz::CarpetPlot::GetChannel ( )

get active channel

Definition at line 561 of file DAFFVizCarpetPlot.cpp.

int DAFFViz::CarpetPlot::getFixedAngle ( )

Get fixed angle (ALPHA_FIXED | BETA_FIXED)

Definition at line 327 of file DAFFVizCarpetPlot.cpp.

double DAFFViz::CarpetPlot::GetRangeMax ( ) const

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

Definition at line 372 of file DAFFVizCarpetPlot.cpp.

double DAFFViz::CarpetPlot::GetRangeMin ( ) const

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

Definition at line 359 of file DAFFVizCarpetPlot.cpp.

int DAFFViz::CarpetPlot::getScalarVisibility ( )

Get whether scalars should be used to color the model.

Definition at line 354 of file DAFFVizCarpetPlot.cpp.

int DAFFViz::CarpetPlot::GetScaling ( ) const

Get scaling (SCALING_LINEAR | SCALING_DECIBEL)

Definition at line 316 of file DAFFVizCarpetPlot.cpp.

float DAFFViz::CarpetPlot::GetSelectedAngle ( ) const

Returns the currently selected angle in degree (interval [-90° 90°])

Definition at line 303 of file DAFFVizCarpetPlot.cpp.

void DAFFViz::CarpetPlot::GtWarpingEnabled ( bool  ) const
void DAFFViz::CarpetPlot::SetChannel ( int  iChannel)

Set active channel.

Definition at line 555 of file DAFFVizCarpetPlot.cpp.

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

Set display mode (MODE_SURFACE | MODE_WIREFRAME | MODE_POINT)

Definition at line 545 of file DAFFVizCarpetPlot.cpp.

void DAFFViz::CarpetPlot::SetFixedAngle ( int  iFixedAngle)

Set fixed angle (ALPHA_FIXED | BETA_FIXED)

Definition at line 320 of file DAFFVizCarpetPlot.cpp.

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

Set probe angles.

Definition at line 283 of file DAFFVizCarpetPlot.cpp.

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

Enables/disables probe.

Definition at line 289 of file DAFFVizCarpetPlot.cpp.

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

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

Definition at line 331 of file DAFFVizCarpetPlot.cpp.

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

Set whether scalars should be used to color the model.

Definition at line 349 of file DAFFVizCarpetPlot.cpp.

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

Set scaling (SCALING_LINEAR | SCALING_DECIBEL)

Definition at line 308 of file DAFFVizCarpetPlot.cpp.

void DAFFViz::CarpetPlot::SetSelectedAngle ( float  fAngle)

Sets the currently selected angle in degree.

Definition at line 295 of file DAFFVizCarpetPlot.cpp.

void DAFFViz::CarpetPlot::SetWarpingEnabled ( bool  bEnabled)

Definition at line 380 of file DAFFVizCarpetPlot.cpp.

void DAFFViz::CarpetPlot::UpdateProbe ( )

Update probe nodes.

Definition at line 238 of file DAFFVizCarpetPlot.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.