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

Public Member Functions

 ShapeFrameNode (dart::dynamics::ShapeFrame *frame, WorldNode *worldNode)
 Create a ShapeFrameNode. More...
 
dart::dynamics::ShapeFramegetShapeFrame (bool checkUtilization=false)
 Pointer to the ShapeFrame associated with this ShapeFrameNode.
 
const dart::dynamics::ShapeFramegetShapeFrame (bool checkUtilization=false) const
 Pointer to the ShapeFrame associated with this ShapeFrameNode.
 
WorldNodegetWorldNode ()
 
const WorldNodegetWorldNode () const
 
void refresh (bool shortCircuitIfUtilized=false)
 Update all rendering data for this ShapeFrame. More...
 
bool wasUtilized () const
 True iff this ShapeFrameNode has been utilized on the latest update.
 
void clearUtilization ()
 Set mUtilized to false.
 

Protected Member Functions

void refreshShapeNode (const std::shared_ptr< dart::dynamics::Shape > &shape)
 
void createShapeNode (const std::shared_ptr< dart::dynamics::Shape > &shape)
 

Protected Attributes

dart::dynamics::ShapeFramemShapeFrame
 Pointer to the ShapeFrame that this ShapeFrameNode is associated with.
 
WorldNodemWorldNode
 Pointer to the WorldNode that this ShapeFrameNode belongs to.
 
render::ShapeNodemRenderShapeNode
 
bool mUtilized
 True iff this ShapeFrameNode has been utilized on the latest update. More...
 

Constructor & Destructor Documentation

◆ ShapeFrameNode()

dart::gui::osg::ShapeFrameNode::ShapeFrameNode ( dart::dynamics::ShapeFrame frame,
WorldNode worldNode 
)

Create a ShapeFrameNode.

If recursive is set to true, it will also create nodes for all child Entities and child Frames

Member Function Documentation

◆ refresh()

void dart::gui::osg::ShapeFrameNode::refresh ( bool  shortCircuitIfUtilized = false)

Update all rendering data for this ShapeFrame.

If shortCircuitIfUtilized is true, this will skip the refresh process if mUtilized is set to true. clearUtilization() needs to be called before this function if short circuiting is going to be used.

Member Data Documentation

◆ mUtilized

bool dart::gui::osg::ShapeFrameNode::mUtilized
protected

True iff this ShapeFrameNode has been utilized on the latest update.

If it has not, that is an indication that it is no longer being used and should be deleted.


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