dart
Public Member Functions | Protected Attributes | List of all members
WamWorld Class Reference
Inheritance diagram for WamWorld:
Inheritance graph
[legend]
Collaboration diagram for WamWorld:
Collaboration graph
[legend]

Public Member Functions

 WamWorld (WorldPtr world, SkeletonPtr robot)
 
void customPreRefresh () override
 If update() is not overloaded, this function will be called at the beginning of each rendering cycle. More...
 
- Public Member Functions inherited from dart::gui::osg::WorldNode
 WorldNode (std::shared_ptr< dart::simulation::World > world=nullptr, ::osg::ref_ptr< osgShadow::ShadowTechnique > shadowTechnique=nullptr)
 Default constructor Shadows are disabled by default.
 
void setWorld (std::shared_ptr< dart::simulation::World > newWorld)
 Set the World that this WorldNode is associated with.
 
std::shared_ptr< dart::simulation::WorldgetWorld () const
 Get the World that this WorldNode is associated with.
 
virtual void refresh ()
 This function is called at the beginning of each rendering cycle. More...
 
virtual void customPostRefresh ()
 If update() is not overloaded, this function will be called at the end of each rendering cycle. More...
 
virtual void customPreStep ()
 If update() is not overloaded, this function will be called at the beginning of each simulation step. More...
 
virtual void customPostStep ()
 If update() is not overloaded, this function will be called at the end of each simulation step. More...
 
bool isSimulating () const
 Returns true iff the WorldNode is stepping between render cycles.
 
void simulate (bool on)
 Pass in true to take steps between render cycles; pass in false to turn off steps between render cycles. More...
 
void setNumStepsPerCycle (std::size_t steps)
 Set the number of steps to take between each render cycle (only if the simulation is not paused)
 
std::size_t getNumStepsPerCycle () const
 Get the number of steps that will be taken between each render cycle (only if the simulation is not paused)
 
bool isShadowed () const
 Get whether the WorldNode is casting shadows.
 
void setShadowTechnique (::osg::ref_ptr< osgShadow::ShadowTechnique > shadowTechnique=nullptr)
 Set the ShadowTechnique If you wish to disable shadows, pass a nullptr.
 
::osg::ref_ptr< osgShadow::ShadowTechnique > getShadowTechnique () const
 Get the current ShadowTechnique nullptr is there are no shadows.
 
static ::osg::ref_ptr< osgShadow::ShadowTechnique > createDefaultShadowTechnique (const Viewer *viewer)
 Helper function to create a default ShadowTechnique given a Viewer the default ShadowTechnique is ShadowMap.
 
virtual ~WorldNode ()
 Destructor.
 

Protected Attributes

SkeletonPtr mWam
 
- Protected Attributes inherited from dart::gui::osg::WorldNode
NodeMap mFrameToNode
 Map from Frame pointers to FrameNode pointers.
 
std::shared_ptr< dart::simulation::WorldmWorld
 The World that this WorldNode is associated with.
 
bool mSimulating
 True iff simulation is active.
 
std::size_t mNumStepsPerCycle
 Number of steps to take between rendering cycles.
 
ViewermViewer
 Viewer that this WorldNode is inside of.
 
::osg::ref_ptr<::osg::Group > mNormalGroup
 OSG group for non-shadowed objects.
 
::osg::ref_ptr<::osgShadow::ShadowedScene > mShadowedGroup
 OSG group for shadowed objects.
 
bool mShadowed
 Whether the shadows are enabled.
 

Additional Inherited Members

- Protected Types inherited from dart::gui::osg::WorldNode
using NodeMap = std::unordered_map< dart::dynamics::Frame *, ::osg::ref_ptr< ShapeFrameNode > >
 
- Protected Member Functions inherited from dart::gui::osg::WorldNode
virtual void setupViewer ()
 Called when this world gets added to an dart::gui::osg::Viewer. More...
 
void clearChildUtilizationFlags ()
 Clear the utilization flags of each child node.
 
void clearUnusedNodes ()
 Clear any nodes whose utilization flags were not triggered on this render cycle.
 
void refreshSkeletons ()
 Refresh all the Skeleton rendering data.
 
void refreshSimpleFrames ()
 Refresh all the custom Frame rendering data.
 
void refreshBaseFrameNode (dart::dynamics::Frame *frame)
 
void refreshShapeFrameNode (dart::dynamics::Frame *frame)
 

Member Function Documentation

◆ customPreRefresh()

void WamWorld::customPreRefresh ( )
overridevirtual

If update() is not overloaded, this function will be called at the beginning of each rendering cycle.

This function can be overloaded to customize the behavior of each update. The default behavior is to do nothing, so overloading this function will not interfere with the usual update() operation.

Reimplemented from dart::gui::osg::WorldNode.


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