SOFA API  c76874b7
Open source framework for multi-physics simuation
sofa::core::visual::DisplayFlags Class Reference

#include <DisplayFlags.h>

Class which describes the display of components in a hierarchical fashion DisplayFlags are conveyed by the VisualParams, and therefore are accessible in a read only fashion inside a Component draw method. A component can tell if it should draw something on the display by looking at the current state of the displayFlags through the VisualParams parameter. DisplayFlags are embeddable inside a Data and can therefore read/write their state from a stream. More...

Detailed Description

Class which describes the display of components in a hierarchical fashion DisplayFlags are conveyed by the VisualParams, and therefore are accessible in a read only fashion inside a Component draw method. A component can tell if it should draw something on the display by looking at the current state of the displayFlags through the VisualParams parameter. DisplayFlags are embeddable inside a Data and can therefore read/write their state from a stream.

root |–all | |–visual | | |–visualmodels | |–behavior | | |–behaviormodels | | |–forcefields | | |–interactionforcefields | |–collision | | |–collisionmodels | | |–boundingcollisionmodels | |–mapping | | |–visualmappings | | |–mechanicalmappings |–options | |–advancedrendering | |–wireframe | |–normals

Protected Attributes

FlagTreeItem m_root
 
FlagTreeItem m_showAll
 
FlagTreeItem m_showVisual
 
FlagTreeItem m_showVisualModels
 
FlagTreeItem m_showBehavior
 
FlagTreeItem m_showBehaviorModels
 
FlagTreeItem m_showForceFields
 
FlagTreeItem m_showInteractionForceFields
 
FlagTreeItem m_showCollision
 
FlagTreeItem m_showCollisionModels
 
FlagTreeItem m_showBoundingCollisionModels
 
FlagTreeItem m_showMapping
 
FlagTreeItem m_showVisualMappings
 
FlagTreeItem m_showMechanicalMappings
 
FlagTreeItem m_showOptions
 
FlagTreeItem m_showAdvancedRendering
 
FlagTreeItem m_showWireframe
 
FlagTreeItem m_showNormals
 

Public Member Functions

 DisplayFlags ()
 
 DisplayFlags (const DisplayFlags &)
 
DisplayFlagsoperator= (const DisplayFlags &)
 
tristate getShowAll () const
 
tristate getShowVisual () const
 
tristate getShowVisualModels () const
 
tristate getShowBehavior () const
 
tristate getShowBehaviorModels () const
 
tristate getShowForceFields () const
 
tristate getShowInteractionForceFields () const
 
tristate getShowCollision () const
 
tristate getShowCollisionModels () const
 
tristate getShowBoundingCollisionModels () const
 
tristate getShowMapping () const
 
tristate getShowMappings () const
 
tristate getShowMechanicalMappings () const
 
tristate getShowOptions () const
 
tristate getShowAdvancedRendering () const
 
tristate getShowWireFrame () const
 
tristate getShowNormals () const
 
DisplayFlagssetShowAll (tristate v=true)
 
DisplayFlagssetShowVisual (tristate v=true)
 
DisplayFlagssetShowVisualModels (tristate v=true)
 
DisplayFlagssetShowBehavior (tristate v=true)
 
DisplayFlagssetShowBehaviorModels (tristate v=true)
 
DisplayFlagssetShowForceFields (tristate v=true)
 
DisplayFlagssetShowInteractionForceFields (tristate v=true)
 
DisplayFlagssetShowCollision (tristate v=true)
 
DisplayFlagssetShowCollisionModels (tristate v=true)
 
DisplayFlagssetShowBoundingCollisionModels (tristate v=true)
 
DisplayFlagssetShowMapping (tristate v=true)
 
DisplayFlagssetShowMappings (tristate v=true)
 
DisplayFlagssetShowMechanicalMappings (tristate v=true)
 
DisplayFlagssetShowOptions (tristate v=true)
 
DisplayFlagssetShowAdvancedRendering (tristate v=true)
 
DisplayFlagssetShowWireFrame (tristate v=true)
 
DisplayFlagssetShowNormals (tristate v=true)
 
bool isNeutral () const
 

Friends

std::ostream & operator<< (std::ostream &os, const DisplayFlags &flags)
 
std::istream & operator>> (std::istream &in, DisplayFlags &flags)
 
SOFA_CORE_API DisplayFlags merge_displayFlags (const DisplayFlags &previous, const DisplayFlags &current)
 
SOFA_CORE_API DisplayFlags difference_displayFlags (const DisplayFlags &parent, const DisplayFlags &child)
 

Attribute details

FlagTreeItem sofa::core::visual::DisplayFlags::m_root
protected
FlagTreeItem sofa::core::visual::DisplayFlags::m_showAdvancedRendering
protected
FlagTreeItem sofa::core::visual::DisplayFlags::m_showAll
protected
FlagTreeItem sofa::core::visual::DisplayFlags::m_showBehavior
protected
FlagTreeItem sofa::core::visual::DisplayFlags::m_showBehaviorModels
protected
FlagTreeItem sofa::core::visual::DisplayFlags::m_showBoundingCollisionModels
protected
FlagTreeItem sofa::core::visual::DisplayFlags::m_showCollision
protected
FlagTreeItem sofa::core::visual::DisplayFlags::m_showCollisionModels
protected
FlagTreeItem sofa::core::visual::DisplayFlags::m_showForceFields
protected
FlagTreeItem sofa::core::visual::DisplayFlags::m_showInteractionForceFields
protected
FlagTreeItem sofa::core::visual::DisplayFlags::m_showMapping
protected
FlagTreeItem sofa::core::visual::DisplayFlags::m_showMechanicalMappings
protected
FlagTreeItem sofa::core::visual::DisplayFlags::m_showNormals
protected
FlagTreeItem sofa::core::visual::DisplayFlags::m_showOptions
protected
FlagTreeItem sofa::core::visual::DisplayFlags::m_showVisual
protected
FlagTreeItem sofa::core::visual::DisplayFlags::m_showVisualMappings
protected
FlagTreeItem sofa::core::visual::DisplayFlags::m_showVisualModels
protected
FlagTreeItem sofa::core::visual::DisplayFlags::m_showWireframe
protected

Constructor details

sofa::core::visual::DisplayFlags::DisplayFlags ( )
sofa::core::visual::DisplayFlags::DisplayFlags ( const DisplayFlags other)

Function details

tristate sofa::core::visual::DisplayFlags::getShowAdvancedRendering ( ) const
inline
tristate sofa::core::visual::DisplayFlags::getShowAll ( ) const
inline
tristate sofa::core::visual::DisplayFlags::getShowBehavior ( ) const
inline
tristate sofa::core::visual::DisplayFlags::getShowBehaviorModels ( ) const
inline
tristate sofa::core::visual::DisplayFlags::getShowBoundingCollisionModels ( ) const
inline
tristate sofa::core::visual::DisplayFlags::getShowCollision ( ) const
inline
tristate sofa::core::visual::DisplayFlags::getShowCollisionModels ( ) const
inline
tristate sofa::core::visual::DisplayFlags::getShowForceFields ( ) const
inline
tristate sofa::core::visual::DisplayFlags::getShowInteractionForceFields ( ) const
inline
tristate sofa::core::visual::DisplayFlags::getShowMapping ( ) const
inline
tristate sofa::core::visual::DisplayFlags::getShowMappings ( ) const
inline
tristate sofa::core::visual::DisplayFlags::getShowMechanicalMappings ( ) const
inline
tristate sofa::core::visual::DisplayFlags::getShowNormals ( ) const
inline
tristate sofa::core::visual::DisplayFlags::getShowOptions ( ) const
inline
tristate sofa::core::visual::DisplayFlags::getShowVisual ( ) const
inline
tristate sofa::core::visual::DisplayFlags::getShowVisualModels ( ) const
inline
tristate sofa::core::visual::DisplayFlags::getShowWireFrame ( ) const
inline
bool sofa::core::visual::DisplayFlags::isNeutral ( ) const
DisplayFlags & sofa::core::visual::DisplayFlags::operator= ( const DisplayFlags other)
DisplayFlags& sofa::core::visual::DisplayFlags::setShowAdvancedRendering ( tristate  v = true)
inline
DisplayFlags& sofa::core::visual::DisplayFlags::setShowAll ( tristate  v = true)
inline
DisplayFlags& sofa::core::visual::DisplayFlags::setShowBehavior ( tristate  v = true)
inline
DisplayFlags& sofa::core::visual::DisplayFlags::setShowBehaviorModels ( tristate  v = true)
inline
DisplayFlags& sofa::core::visual::DisplayFlags::setShowBoundingCollisionModels ( tristate  v = true)
inline
DisplayFlags& sofa::core::visual::DisplayFlags::setShowCollision ( tristate  v = true)
inline
DisplayFlags& sofa::core::visual::DisplayFlags::setShowCollisionModels ( tristate  v = true)
inline
DisplayFlags& sofa::core::visual::DisplayFlags::setShowForceFields ( tristate  v = true)
inline
DisplayFlags& sofa::core::visual::DisplayFlags::setShowInteractionForceFields ( tristate  v = true)
inline
DisplayFlags& sofa::core::visual::DisplayFlags::setShowMapping ( tristate  v = true)
inline
DisplayFlags& sofa::core::visual::DisplayFlags::setShowMappings ( tristate  v = true)
inline
DisplayFlags& sofa::core::visual::DisplayFlags::setShowMechanicalMappings ( tristate  v = true)
inline
DisplayFlags& sofa::core::visual::DisplayFlags::setShowNormals ( tristate  v = true)
inline
DisplayFlags& sofa::core::visual::DisplayFlags::setShowOptions ( tristate  v = true)
inline
DisplayFlags& sofa::core::visual::DisplayFlags::setShowVisual ( tristate  v = true)
inline
DisplayFlags& sofa::core::visual::DisplayFlags::setShowVisualModels ( tristate  v = true)
inline
DisplayFlags& sofa::core::visual::DisplayFlags::setShowWireFrame ( tristate  v = true)
inline

Related details

SOFA_CORE_API DisplayFlags difference_displayFlags ( const DisplayFlags parent,
const DisplayFlags child 
)
friend
SOFA_CORE_API DisplayFlags merge_displayFlags ( const DisplayFlags previous,
const DisplayFlags current 
)
friend
std::ostream& operator<< ( std::ostream &  os,
const DisplayFlags flags 
)
friend
std::istream& operator>> ( std::istream &  in,
DisplayFlags flags 
)
friend