DART  6.6.2
dart::dynamics::VisualAspect Class Referencefinal

#include <ShapeFrame.hpp>

Inheritance diagram for dart::dynamics::VisualAspect:
dart::common::detail::AspectWithVersionedProperties< BaseT, DerivedT, PropertiesDataT, CompositeT, updateProperties >

Public Types

using Base = common::AspectWithVersionedProperties< VisualAspect, detail::VisualAspectProperties, ShapeFrame >
 
using Derived = DerivedT
 
using PropertiesData = PropertiesDataT
 
using CompositeType = CompositeT
 
using Properties = Aspect::MakeProperties< PropertiesData >
 
using AspectImplementation = AspectWithVersionedProperties< Base, Derived, PropertiesData, CompositeT, updateProperties >
 

Public Member Functions

 VisualAspect (const PropertiesData &properties=PropertiesData())
 Constructor. More...
 
 VisualAspect (const VisualAspect &)=delete
 
void setRGBA (const Eigen::Vector4d &color)
 Set RGBA color. More...
 
const Eigen::Vector4d & getRGBA () const
 
void setHidden (const bool &value)
 
const bool & getHidden () const
 
void setShadowed (const bool &value)
 
const bool & getShadowed () const
 
void setColor (const Eigen::Vector3d &color)
 Identical to setRGB(const Eigen::Vector3d&) More...
 
void setColor (const Eigen::Vector4d &color)
 Identical to setRGBA(const Eigen::Vector4d&) More...
 
void setRGB (const Eigen::Vector3d &rgb)
 Set RGB color components (leave alpha alone) More...
 
void setAlpha (const double alpha)
 Set the transparency of the Shape. More...
 
Eigen::Vector3d getColor () const
 Get color. More...
 
Eigen::Vector3d getRGB () const
 Get RGB color components. More...
 
double getAlpha () const
 Get the transparency of the Shape. More...
 
void hide ()
 Hide the ShapeNode. More...
 
void show ()
 Show the ShapeNode. More...
 
bool isHidden () const
 True iff the ShapeNode is set to be hidden. More...
 
void setAspectProperties (const Aspect::Properties &someProperties) override final
 
const Aspect::Properties * getAspectProperties () const override final
 
void setProperties (const PropertiesData &properties)
 Set the Properties of this Aspect. More...
 
const PropertiesgetProperties () const
 Get the Properties of this Aspect. More...
 
std::unique_ptr< Aspect > cloneAspect () const override
 
std::size_t incrementVersion ()
 Increment the version of this Aspect and its Composite. More...
 
void notifyPropertiesUpdate ()
 Call UpdateProperties(this) and incrementVersion() More...
 
void notifyPropertiesUpdated ()
 Call UpdateProperties(this) and incrementVersion() More...
 

Static Public Attributes

constexpr static void(* UpdateProperties )(Derived *) = updateProperties
 

Protected Attributes

Properties mProperties
 Properties of this Aspect. More...
 

Member Typedef Documentation

◆ AspectImplementation

template<class BaseT , class DerivedT , typename PropertiesDataT , class CompositeT = Composite, void(*)(DerivedT *) updateProperties = &NoOp<DerivedT*>>
using dart::common::detail::AspectWithVersionedProperties< BaseT, DerivedT, PropertiesDataT, CompositeT, updateProperties >::AspectImplementation = AspectWithVersionedProperties< Base, Derived, PropertiesData, CompositeT, updateProperties>
inherited

◆ Base

◆ CompositeType

template<class BaseT , class DerivedT , typename PropertiesDataT , class CompositeT = Composite, void(*)(DerivedT *) updateProperties = &NoOp<DerivedT*>>
using dart::common::detail::AspectWithVersionedProperties< BaseT, DerivedT, PropertiesDataT, CompositeT, updateProperties >::CompositeType = CompositeT
inherited

◆ Derived

template<class BaseT , class DerivedT , typename PropertiesDataT , class CompositeT = Composite, void(*)(DerivedT *) updateProperties = &NoOp<DerivedT*>>
using dart::common::detail::AspectWithVersionedProperties< BaseT, DerivedT, PropertiesDataT, CompositeT, updateProperties >::Derived = DerivedT
inherited

◆ Properties

template<class BaseT , class DerivedT , typename PropertiesDataT , class CompositeT = Composite, void(*)(DerivedT *) updateProperties = &NoOp<DerivedT*>>
using dart::common::detail::AspectWithVersionedProperties< BaseT, DerivedT, PropertiesDataT, CompositeT, updateProperties >::Properties = Aspect::MakeProperties<PropertiesData>
inherited

◆ PropertiesData

template<class BaseT , class DerivedT , typename PropertiesDataT , class CompositeT = Composite, void(*)(DerivedT *) updateProperties = &NoOp<DerivedT*>>
using dart::common::detail::AspectWithVersionedProperties< BaseT, DerivedT, PropertiesDataT, CompositeT, updateProperties >::PropertiesData = PropertiesDataT
inherited

Constructor & Destructor Documentation

◆ VisualAspect() [1/2]

dart::dynamics::VisualAspect::VisualAspect ( const PropertiesData properties = PropertiesData())

Constructor.

◆ VisualAspect() [2/2]

dart::dynamics::VisualAspect::VisualAspect ( const VisualAspect )
delete

Member Function Documentation

◆ cloneAspect()

template<class BaseT , class DerivedT , typename PropertiesData , class CompositeT , void(*)(DerivedT *) updateProperties>
std::unique_ptr< Aspect > dart::common::detail::AspectWithVersionedProperties< BaseT, DerivedT, PropertiesData, CompositeT, updateProperties >::cloneAspect
overrideinherited

◆ getAlpha()

double dart::dynamics::VisualAspect::getAlpha ( ) const

Get the transparency of the Shape.

◆ getAspectProperties()

template<class BaseT , class DerivedT , typename PropertiesData , class CompositeT , void(*)(DerivedT *) updateProperties>
const Aspect::Properties * dart::common::detail::AspectWithVersionedProperties< BaseT, DerivedT, PropertiesData, CompositeT, updateProperties >::getAspectProperties
finaloverrideinherited

◆ getColor()

Eigen::Vector3d dart::dynamics::VisualAspect::getColor ( ) const

Get color.

◆ getHidden()

const bool& dart::dynamics::VisualAspect::getHidden ( ) const
inline

◆ getProperties()

template<class BaseT , class DerivedT , typename PropertiesData , class CompositeT , void(*)(DerivedT *) updateProperties>
auto dart::common::detail::AspectWithVersionedProperties< BaseT, DerivedT, PropertiesData, CompositeT, updateProperties >::getProperties
inherited

Get the Properties of this Aspect.

◆ getRGB()

Eigen::Vector3d dart::dynamics::VisualAspect::getRGB ( ) const

Get RGB color components.

◆ getRGBA()

const Eigen::Vector4d& dart::dynamics::VisualAspect::getRGBA ( ) const
inline

◆ getShadowed()

const bool& dart::dynamics::VisualAspect::getShadowed ( ) const
inline

◆ hide()

void dart::dynamics::VisualAspect::hide ( )

Hide the ShapeNode.

◆ incrementVersion()

template<class BaseT , class DerivedT , typename PropertiesData , class CompositeT , void(*)(DerivedT *) updateProperties>
std::size_t dart::common::detail::AspectWithVersionedProperties< BaseT, DerivedT, PropertiesData, CompositeT, updateProperties >::incrementVersion
inherited

Increment the version of this Aspect and its Composite.

◆ isHidden()

bool dart::dynamics::VisualAspect::isHidden ( ) const

True iff the ShapeNode is set to be hidden.

Use hide(bool) to change this setting

◆ notifyPropertiesUpdate()

template<class BaseT , class DerivedT , typename PropertiesData , class CompositeT , void(*)(DerivedT *) updateProperties>
void dart::common::detail::AspectWithVersionedProperties< BaseT, DerivedT, PropertiesData, CompositeT, updateProperties >::notifyPropertiesUpdate
inherited

Call UpdateProperties(this) and incrementVersion()

◆ notifyPropertiesUpdated()

template<class BaseT , class DerivedT , typename PropertiesData , class CompositeT , void(*)(DerivedT *) updateProperties>
void dart::common::detail::AspectWithVersionedProperties< BaseT, DerivedT, PropertiesData, CompositeT, updateProperties >::notifyPropertiesUpdated
inherited

Call UpdateProperties(this) and incrementVersion()

◆ setAlpha()

void dart::dynamics::VisualAspect::setAlpha ( const double  alpha)

Set the transparency of the Shape.

◆ setAspectProperties()

template<class BaseT , class DerivedT , typename PropertiesData , class CompositeT , void(*)(DerivedT *) updateProperties>
void dart::common::detail::AspectWithVersionedProperties< BaseT, DerivedT, PropertiesData, CompositeT, updateProperties >::setAspectProperties ( const Aspect::Properties someProperties)
finaloverrideinherited

◆ setColor() [1/2]

void dart::dynamics::VisualAspect::setColor ( const Eigen::Vector3d &  color)

◆ setColor() [2/2]

void dart::dynamics::VisualAspect::setColor ( const Eigen::Vector4d &  color)

◆ setHidden()

void dart::dynamics::VisualAspect::setHidden ( const bool &  value)
inline

◆ setProperties()

template<class BaseT , class DerivedT , typename PropertiesData , class CompositeT , void(*)(DerivedT *) updateProperties>
void dart::common::detail::AspectWithVersionedProperties< BaseT, DerivedT, PropertiesData, CompositeT, updateProperties >::setProperties ( const PropertiesData properties)
inherited

Set the Properties of this Aspect.

◆ setRGB()

void dart::dynamics::VisualAspect::setRGB ( const Eigen::Vector3d &  rgb)

Set RGB color components (leave alpha alone)

◆ setRGBA()

void dart::dynamics::VisualAspect::setRGBA ( const Eigen::Vector4d &  color)

Set RGBA color.

◆ setShadowed()

void dart::dynamics::VisualAspect::setShadowed ( const bool &  value)
inline

◆ show()

void dart::dynamics::VisualAspect::show ( )

Show the ShapeNode.

Member Data Documentation

◆ mProperties

template<class BaseT , class DerivedT , typename PropertiesDataT , class CompositeT = Composite, void(*)(DerivedT *) updateProperties = &NoOp<DerivedT*>>
Properties dart::common::detail::AspectWithVersionedProperties< BaseT, DerivedT, PropertiesDataT, CompositeT, updateProperties >::mProperties
protectedinherited

Properties of this Aspect.

◆ UpdateProperties

template<class BaseT , class DerivedT , typename PropertiesDataT , class CompositeT = Composite, void(*)(DerivedT *) updateProperties = &NoOp<DerivedT*>>
constexpr static void(* dart::common::detail::AspectWithVersionedProperties< BaseT, DerivedT, PropertiesDataT, CompositeT, updateProperties >::UpdateProperties) (Derived *) = updateProperties
staticconstexprinherited