Helios++
Helios software for LiDAR simulations
visualhelios::VHDynObjectAdapter Class Reference

Abstract class defining core mechanisms to adapt dynamic objects to the visual Helios context based on PCL and VTK libraries. More...

#include <VHDynObjectAdapter.h>

Inheritance diagram for visualhelios::VHDynObjectAdapter:
Collaboration diagram for visualhelios::VHDynObjectAdapter:

Public Member Functions

 VHDynObjectAdapter (DynObject &dynObj)
 Constructor for the visual Helios dynamic object adapter. More...
 
bool doStep (bool const forceStep=false, bool const forceRebuild=false)
 Method to adapt dynamic object computations over time to visual Helios. More...
 
DynObjectgetDynObj ()
 Obtain the dynamic object. More...
 
- Public Member Functions inherited from visualhelios::VHStaticObjectAdapter
 VHStaticObjectAdapter (ScenePart &staticObj)
 Constructor for the visual Helios static object adapter. More...
 
virtual void buildPolymesh ()
 Build the polygon mesh from static object primitives. This implies building corresponding vertices vector too. More...
 
virtual void constructPolymesh ()=0
 Instantiate the polymesh object. More...
 
virtual void vertexToMesh (Vertex const &vertex)=0
 Add a vertex to the polymesh. More...
 
virtual void addTriangleToPolymesh (Primitive *primitive, int &offset)
 Function to add triangle primitives to the polymesh during building time. More...
 
virtual void addVoxelToPolymesh (Primitive *primitive, int &offset)
 Function to add voxel primitives to the polymesh during building time. More...
 
ScenePartgetStaticObj ()
 Obtain the static object. More...
 
vector< pcl::Vertices > const & getVertices () const
 Obtain the ordered vertices indices representing the static object. More...
 
string const & getId () const
 Obtain the ID of the static object. More...
 
bool isRenderingNormals () const
 Check whether the static object normals must be rendered or not. More...
 
void setRenderingNormals (bool const renderingNormals)
 Enable or disable normals rendering for the static object. More...
 

Additional Inherited Members

- Protected Attributes inherited from visualhelios::VHStaticObjectAdapter
ScenePartstaticObj
 The adapted static object. More...
 
vector< pcl::Vertices > vertices
 Static object vertices connection specification through ordered indices for visualization purposes. More...
 
bool renderingNormals
 Specify if the static object normals must be rendered (true) or not (false)
 

Detailed Description

Abstract class defining core mechanisms to adapt dynamic objects to the visual Helios context based on PCL and VTK libraries.

Author
Alberto M. Esmoris Pena
Version
1.0

Constructor & Destructor Documentation

◆ VHDynObjectAdapter()

visualhelios::VHDynObjectAdapter::VHDynObjectAdapter ( DynObject dynObj)
inline

Constructor for the visual Helios dynamic object adapter.

Parameters
dynObjDynamic object to be adapted for visual Helios

Member Function Documentation

◆ doStep()

bool VHDynObjectAdapter::doStep ( bool const  forceStep = false,
bool const  forceRebuild = false 
)

Method to adapt dynamic object computations over time to visual Helios.

Parameters
forceStepTrue to specify that underlying dynamic object must be forced to execute its doStep method, false otherwise. Forcing step might be useful to force dynamic object step computation when it does not belong to a dynamic scene which handles doStep calls.
forceRebuildTrue to specify the polygon mesh must be rebuilt, false otherwise.
Returns
True if the dynamic object was modified, false otherwise

◆ getDynObj()

DynObject& visualhelios::VHDynObjectAdapter::getDynObj ( )
inline

Obtain the dynamic object.

WARNING this getter returns the dynamic object reference allowing modifications. Use with caution.

Returns
Dynamic object

The documentation for this class was generated from the following files: