dart
Public Types | Public Member Functions | List of all members
dart::dynamics::VisualAspect Class Referencefinal
Inheritance diagram for dart::dynamics::VisualAspect:
Inheritance graph
[legend]
Collaboration diagram for dart::dynamics::VisualAspect:
Collaboration graph
[legend]

Public Types

using Base = common::AspectWithVersionedProperties< VisualAspect, detail::VisualAspectProperties, ShapeFrame >
 
- Public Types inherited from dart::common::detail::AspectWithVersionedProperties< BaseT, DerivedT, PropertiesDataT, CompositeT, updateProperties >
using Base = BaseT
 
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.
 
 VisualAspect (const VisualAspect &)=delete
 
void setRGBA (const Eigen::Vector4d &color)
 Set RGBA color.
 
void setColor (const Eigen::Vector3d &color)
 Identical to setRGB(const Eigen::Vector3d&)
 
void setColor (const Eigen::Vector4d &color)
 Identical to setRGBA(const Eigen::Vector4d&)
 
void setRGB (const Eigen::Vector3d &rgb)
 Set RGB color components (leave alpha alone)
 
void setAlpha (const double alpha)
 Set the transparency of the Shape.
 
Eigen::Vector3d getColor () const
 Get color.
 
Eigen::Vector3d getRGB () const
 Get RGB color components.
 
double getAlpha () const
 Get the transparency of the Shape.
 
void hide ()
 Hide the ShapeNode.
 
void show ()
 Show the ShapeNode.
 
bool isHidden () const
 True iff the ShapeNode is set to be hidden. More...
 
- Public Member Functions inherited from dart::common::detail::AspectWithVersionedProperties< BaseT, DerivedT, PropertiesDataT, CompositeT, updateProperties >
 AspectWithVersionedProperties (const AspectWithVersionedProperties &)=delete
 
 AspectWithVersionedProperties (const PropertiesData &properties=PropertiesData())
 Construct using a PropertiesData instance.
 
template<typename... BaseArgs>
 AspectWithVersionedProperties (const PropertiesData &properties, BaseArgs &&... args)
 Construct this Aspect and pass args into the constructor of the Base class.
 
void setAspectProperties (const Aspect::Properties &someProperties) override final
 
const Aspect::PropertiesgetAspectProperties () const override final
 
void setProperties (const PropertiesData &properties)
 Set the Properties of this Aspect.
 
const PropertiesgetProperties () const
 Get the Properties of this Aspect.
 
std::unique_ptr< AspectcloneAspect () const override
 
std::size_t incrementVersion ()
 Increment the version of this Aspect and its Composite.
 
void notifyPropertiesUpdate ()
 Call UpdateProperties(this) and incrementVersion()
 
void notifyPropertiesUpdated ()
 Call UpdateProperties(this) and incrementVersion()
 

Additional Inherited Members

- Static Public Attributes inherited from dart::common::detail::AspectWithVersionedProperties< BaseT, DerivedT, PropertiesDataT, CompositeT, updateProperties >
static constexpr void(* UpdateProperties )(Derived *) = updateProperties
 
- Protected Attributes inherited from dart::common::detail::AspectWithVersionedProperties< BaseT, DerivedT, PropertiesDataT, CompositeT, updateProperties >
Properties mProperties
 Properties of this Aspect.
 

Member Function Documentation

◆ isHidden()

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

True iff the ShapeNode is set to be hidden.

Use hide(bool) to change this setting


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