API  4.1
For C++ developers
OpenSim::Appearance Class Reference

A class that holds the Appearance properties of Geometry displayed in the OpenSim Visualizer. More...

+ Inheritance diagram for OpenSim::Appearance:

OpenSim Properties, Sockets, Outputs, Inputs

Properties (single-value)
bool visible
 "Flag indicating whether the associated Geometry is visible or hidden." More...
 
double opacity
 "The opacity used to display the geometry between 0:transparent, 1:opaque." More...
 
SimTK::Vec3 color
 "The color, (red, green, blue), [0, 1], used to display the geometry. " More...
 
Properties (unnamed)
SurfaceProperties SurfaceProperties
 "Visuals applied to surfaces associated with this Appearance." More...
 

Public Member Functions

 Appearance ()
 
virtual ~Appearance ()
 
OpenSim::VisualRepresentation get_representation () const
 
void set_representation (const OpenSim::VisualRepresentation &rep)
 
Property-related functions
const bool & get_visible () const
 Get the value of the visible property. More...
 
bool & upd_visible ()
 Get a writable reference to the visible property. More...
 
void set_visible (const bool &value)
 Set the value of the visible property. More...
 
const double & get_opacity () const
 Get the value of the opacity property. More...
 
double & upd_opacity ()
 Get a writable reference to the opacity property. More...
 
void set_opacity (const double &value)
 Set the value of the opacity property. More...
 
const SimTK::Vec3 & get_color () const
 Get the value of the color property. More...
 
SimTK::Vec3 & upd_color ()
 Get a writable reference to the color property. More...
 
void set_color (const SimTK::Vec3 &value)
 Set the value of the color property. More...
 
const SurfacePropertiesget_SurfaceProperties () const
 Get the value of the SurfaceProperties property. More...
 
SurfacePropertiesupd_SurfaceProperties ()
 Get a writable reference to the SurfaceProperties property. More...
 
void set_SurfaceProperties (const SurfaceProperties &value)
 Set the value of the SurfaceProperties property. More...
 
- Public Member Functions inherited from OpenSim::Object
virtual ~Object ()
 Virtual destructor for cleanup. More...
 
bool isEqualTo (const Object &aObject) const
 Equality operator wrapper for use from languages not supporting operator overloading. More...
 
Objectoperator= (const Object &aObject)
 Copy assignment copies he base class fields, including the properties. More...
 
virtual bool operator== (const Object &aObject) const
 Determine if two objects are equal. More...
 
virtual bool operator< (const Object &aObject) const
 Provide an ordering for objects so they can be put in sorted containers. More...
 
void setName (const std::string &name)
 Set the name of the Object. More...
 
const std::string & getName () const
 Get the name of this Object. More...
 
void setDescription (const std::string &description)
 Set description, a one-liner summary. More...
 
const std::string & getDescription () const
 Get description, a one-liner summary. More...
 
const std::string & getAuthors () const
 Get Authors of this Object. More...
 
void setAuthors (const std::string &authors)
 Set Authors of this object. More...
 
const std::string & getReferences () const
 Get references or publications to cite if using this object. More...
 
void setReferences (const std::string &references)
 Set references or publications to cite if using this object. More...
 
int getNumProperties () const
 Determine how many properties are stored with this Object. More...
 
const AbstractPropertygetPropertyByIndex (int propertyIndex) const
 Get a const reference to a property by its index number, returned as an AbstractProperty. More...
 
AbstractPropertyupdPropertyByIndex (int propertyIndex)
 Get a writable reference to a property by its index number, returned as an AbstractProperty. More...
 
bool hasProperty (const std::string &name) const
 Return true if this Object has a property of any type with the given name, which must not be empty. More...
 
const AbstractPropertygetPropertyByName (const std::string &name) const
 Get a const reference to a property by its name, returned as an AbstractProperty. More...
 
AbstractPropertyupdPropertyByName (const std::string &name)
 Get a writable reference to a property by its name, returned as an AbstractProperty. More...
 
template<class T >
bool hasProperty () const
 Return true if this Object contains an unnamed, one-object property that contains objects of the given template type T. More...
 
template<class T >
const Property< T > & getProperty (const PropertyIndex &index) const
 Get property of known type Property<T> as a const reference; the property must be present and have the right type. More...
 
template<class T >
Property< T > & updProperty (const PropertyIndex &index)
 Get property of known type Property<T> as a writable reference; the property must be present and have the right type. More...
 
bool isObjectUpToDateWithProperties () const
 Returns true if no property's value has changed since the last time setObjectIsUpToDateWithProperties() was called. More...
 
void readObjectFromXMLNodeOrFile (SimTK::Xml::Element &objectElement, int versionNumber)
 We're given an XML element from which we are to populate this Object. More...
 
void updateXMLNode (SimTK::Xml::Element &parent, const AbstractProperty *prop=nullptr) const
 Serialize this object into the XML node that represents it. More...
 
bool getInlined () const
 Inlined means an in-memory Object that is not associated with an XMLDocument. More...
 
void setInlined (bool aInlined, const std::string &aFileName="")
 Mark this as inlined or not and optionally provide a file name to associate with the new XMLDocument for the non-inline case. More...
 
std::string getDocumentFileName () const
 If there is a document associated with this object then return the file name maintained by the document. More...
 
int getDocumentFileVersion () const
 If there is a document associated with this object then return its version number. More...
 
void setAllPropertiesUseDefault (bool aUseDefault)
 
bool print (const std::string &fileName) const
 Write this Object into an XML file of the given name; conventionally the suffix to use is ".osim". More...
 
std::string dump () const
 dump the XML representation of this Object into an std::string and return it. More...
 
virtual bool isA (const char *type) const
 The default implementation returns true only if the supplied string is "Object"; each Object-derived class overrides this to match its own class name. More...
 
const std::string & toString () const
 Wrapper to be used on Java side to display objects in tree; this returns just the object's name. More...
 
PropertySetgetPropertySet ()
 OBSOLETE: Get a reference to the PropertySet maintained by the Object. More...
 
const PropertySetgetPropertySet () const
 

Public Types

typedef Appearance Self
 This typedef might be useful within the member functions of this class. More...
 
typedef Object Super
 Use this typedef to refer to the superclass of this class. More...
 

Protected Member Functions

void updateFromXMLNode (SimTK::Xml::Element &aNode, int versionNumber) override
 Updating XML formating to latest revision. More...
 
- Protected Member Functions inherited from OpenSim::Object
 Object ()
 The default constructor is only for use by constructors of derived types. More...
 
 Object (const std::string &fileName, bool aUpdateFromXMLNode=true)
 Constructor from a file, to be called from other constructors that take a file as input. More...
 
 Object (const Object &source)
 Copy constructor is invoked automatically by derived classes with default copy constructors; otherwise it must be invoked explicitly. More...
 
 Object (SimTK::Xml::Element &aElement)
 Construct the base class portion of an Object from a given Xml element that describes this Object. More...
 
template<class T >
PropertyIndex addProperty (const std::string &name, const std::string &comment, const T &value)
 Define a new single-value property of known type T, with the given name, associated comment, and initial value. More...
 
template<class T >
PropertyIndex addOptionalProperty (const std::string &name, const std::string &comment)
 Add an optional property, meaning it can contain either no value or a single value. More...
 
template<class T >
PropertyIndex addOptionalProperty (const std::string &name, const std::string &comment, const T &value)
 Add an optional property, meaning it can contain either no value or a single value. More...
 
template<class T >
PropertyIndex addListProperty (const std::string &name, const std::string &comment, int minSize, int maxSize)
 Define a new list-valued property of known type T, with the given name, associated comment, minimum (==0) and maximum (>0) allowable list lengths, and a zero-length initial value. More...
 
template<class T , template< class > class Container>
PropertyIndex addListProperty (const std::string &name, const std::string &comment, int minSize, int maxSize, const Container< T > &valueList)
 Define a new list-valued property as above, but assigning an initial value via some templatized container class that supports size() and indexing. More...
 
PropertyIndex getPropertyIndex (const std::string &name) const
 Look up a property by name and return its PropertyIndex if it is found. More...
 
template<class T >
PropertyIndex getPropertyIndex () const
 Look up an unnamed property by the type of object it contains, and return its PropertyIndex if it is found. More...
 
void setObjectIsUpToDateWithProperties ()
 When an object is initialized using the current values of its properties, it can set a flag indicating that it is up to date. More...
 
void clearObjectIsUpToDateWithProperties ()
 For testing or debugging purposes, manually clear the "object is up to date with respect to properties" flag. More...
 
void makeObjectNamesConsistentWithProperties ()
 Make sure the name of an object is consistent with its property type. More...
 
void updateFromXMLDocument ()
 Use this method only if you're deserializing from a file and the object is at the top level; that is, primarily in constructors that take a file name as input. More...
 
void setDocument (XMLDocument *doc)
 Unconditionally set the XMLDocument associated with this object. More...
 
const XMLDocumentgetDocument () const
 Get a const pointer to the document (if any) associated with this object. More...
 
XMLDocumentupdDocument ()
 Get a writable pointer to the document (if any) associated with this object. More...
 

Auto-generated functions

static AppearancesafeDownCast (OpenSim::Object *obj)
 For use in MATLAB and Python to access the concrete class. More...
 
static const std::string & getClassName ()
 This returns "Appearance". More...
 
void assign (Object &aObject) override
 This allows copy assignment in the Java GUI. More...
 
Appearanceclone () const override
 Create a new heap-allocated copy of the concrete object to which this Object refers. More...
 
const std::string & getConcreteClassName () const override
 Returns the class name of the concrete Object-derived class of the actual object referenced by this Object, as a string. More...
 

Additional Inherited Members

- Static Public Member Functions inherited from OpenSim::Object
static void registerType (const Object &defaultObject)
 Register an instance of a class; if the class is already registered it will be replaced. More...
 
static void renameType (const std::string &oldTypeName, const std::string &newTypeName)
 Support versioning by associating the current Object type with an old name. More...
 
static const ObjectgetDefaultInstanceOfType (const std::string &concreteClassName)
 Return a pointer to the default instance of the registered (concrete) Object whose class name is given, or NULL if the type is not registered. More...
 
template<class T >
static bool isObjectTypeDerivedFrom (const std::string &concreteClassName)
 Return true if the given concrete object type represents a subclass of the template object type T, and thus could be referenced with a T*. More...
 
static ObjectnewInstanceOfType (const std::string &concreteClassName)
 Create a new instance of the concrete Object type whose class name is given as concreteClassName. More...
 
static void getRegisteredTypenames (Array< std::string > &typeNames)
 Retrieve all the typenames registered so far. More...
 
template<class T >
static void getRegisteredObjectsOfGivenType (ArrayPtrs< T > &rArray)
 Return an array of pointers to the default instances of all registered (concrete) Object types that derive from a given Object-derived type that does not have to be concrete. More...
 
static bool PrintPropertyInfo (std::ostream &os, const std::string &classNameDotPropertyName, bool printFlagInfo=true)
 Dump formatted property information to a given output stream, useful for creating a "help" facility for registered objects. More...
 
static bool PrintPropertyInfo (std::ostream &os, const std::string &className, const std::string &propertyName, bool printFlagInfo=true)
 Same as the other signature but the class name and property name are provided as two separate strings. More...
 
static ObjectmakeObjectFromFile (const std::string &fileName)
 Create an OpenSim object whose type is based on the tag at the root node of the XML file passed in. More...
 
static const std::string & getClassName ()
 Return the name of this class as a string; i.e., "Object". More...
 
static void setSerializeAllDefaults (bool shouldSerializeDefaults)
 Static function to control whether all registered objects and their properties are written to the defaults section of output files rather than only those values for which the default was explicitly overwritten when read in from an input file or set programmatically. More...
 
static bool getSerializeAllDefaults ()
 Report the value of the "serialize all defaults" flag. More...
 
static bool isKindOf (const char *type)
 Returns true if the passed-in string is "Object"; each Object-derived class defines a method of this name for its own class name. More...
 
static void setDebugLevel (int newLevel)
 Set the debug level to get verbose output. More...
 
static int getDebugLevel ()
 Get current setting of debug level. More...
 
static ObjectSafeCopy (const Object *aObject)
 Use the clone() method to duplicate the given object unless the pointer is null in which case null is returned. More...
 
static void RegisterType (const Object &defaultObject)
 OBSOLETE alternate name for registerType(). More...
 
static void RenameType (const std::string &oldName, const std::string &newName)
 OBSOLETE alternate name for renameType(). More...
 
- Static Public Attributes inherited from OpenSim::Object
static const std::string DEFAULT_NAME
 Name used for default objects when they are serialized. More...
 
- Protected Attributes inherited from OpenSim::Object
PropertySet _propertySet
 OBSOLETE: Property_Deprecated set for serializable member variables of this and derived classes. More...
 

Detailed Description

A class that holds the Appearance properties of Geometry displayed in the OpenSim Visualizer.

It affects how Geometry is displayed.

Appearance contains properties that apply to all geometry. Geometry that have a surface so that it can be textured will utilize SurfaceProperties, while schematic line drawings (e.g. Arrows, Frames) can utilize CurveProperties which offers thickness.

Author
Ayman Habib

Member Typedef Documentation

◆ Self

This typedef might be useful within the member functions of this class.

This is generated by the OpenSim_DECLARE_*_OBJECT macros.

◆ Super

Use this typedef to refer to the superclass of this class.

Avoid using the explicit type name of the superclass; this would introduce bugs if the superclass is changed.

This is generated by the OpenSim_DECLARE_*_OBJECT macros.

Constructor & Destructor Documentation

◆ Appearance()

OpenSim::Appearance::Appearance ( )
inline

◆ ~Appearance()

virtual OpenSim::Appearance::~Appearance ( )
inlinevirtual

Member Function Documentation

◆ assign()

void OpenSim::Appearance::assign ( Object aObject)
inlineoverride

This allows copy assignment in the Java GUI.

Exceptions
Exceptionif the argument is not of type Appearance.

◆ clone()

Appearance* OpenSim::Appearance::clone ( ) const
inlineoverridevirtual

Create a new heap-allocated copy of the concrete object to which this Object refers.

It is up to the caller to delete the returned object when no longer needed. Every concrete object deriving from Object implements this pure virtual method automatically, via the declaration macro it invokes (e.g., OpenSim_DECLARE_CONCRETE_OBJECT()). Note that the concrete class overrides modify the return type to be a pointer to the concrete object; that still overrides the base class method because the return type is covariant with (that is, derives from) Object.

Implements OpenSim::Object.

◆ get_color()

const SimTK::Vec3& OpenSim::Appearance::get_color ( ) const
inline

Get the value of the color property.

◆ get_opacity()

const double& OpenSim::Appearance::get_opacity ( ) const
inline

Get the value of the opacity property.

◆ get_representation()

OpenSim::VisualRepresentation OpenSim::Appearance::get_representation ( ) const
inline

◆ get_SurfaceProperties()

const SurfaceProperties& OpenSim::Appearance::get_SurfaceProperties ( ) const
inline

Get the value of the SurfaceProperties property.

◆ get_visible()

const bool& OpenSim::Appearance::get_visible ( ) const
inline

Get the value of the visible property.

◆ getClassName()

static const std::string& OpenSim::Appearance::getClassName ( )
inlinestatic

This returns "Appearance".

See getConcreteClassName() if you want the class name of the underlying concrete object instead.

This is generated by the OpenSim_DECLARE_*_OBJECT macros.

◆ getConcreteClassName()

const std::string& OpenSim::Appearance::getConcreteClassName ( ) const
inlineoverridevirtual

Returns the class name of the concrete Object-derived class of the actual object referenced by this Object, as a string.

This is the string that is used as the tag for this concrete object in an XML file. Every concrete class derived from Object automatically overrides this method via the declaration macro it uses. See getClassName() to get the class name of the referencing (possibly abstract) class rather than the concrete object.

See also
getClassName()

Implements OpenSim::Object.

◆ safeDownCast()

static Appearance* OpenSim::Appearance::safeDownCast ( OpenSim::Object obj)
inlinestatic

For use in MATLAB and Python to access the concrete class.

Example: cObj = Appearance.safeDownCast(obj). This is equivalent to dynamic_cast<Appearance*>(obj) in C++.

◆ set_color()

void OpenSim::Appearance::set_color ( const SimTK::Vec3 &  value)
inline

Set the value of the color property.

◆ set_opacity()

void OpenSim::Appearance::set_opacity ( const double &  value)
inline

Set the value of the opacity property.

◆ set_representation()

void OpenSim::Appearance::set_representation ( const OpenSim::VisualRepresentation rep)
inline

◆ set_SurfaceProperties()

void OpenSim::Appearance::set_SurfaceProperties ( const SurfaceProperties value)
inline

Set the value of the SurfaceProperties property.

◆ set_visible()

void OpenSim::Appearance::set_visible ( const bool &  value)
inline

Set the value of the visible property.

◆ upd_color()

SimTK::Vec3& OpenSim::Appearance::upd_color ( )
inline

Get a writable reference to the color property.

◆ upd_opacity()

double& OpenSim::Appearance::upd_opacity ( )
inline

Get a writable reference to the opacity property.

◆ upd_SurfaceProperties()

SurfaceProperties& OpenSim::Appearance::upd_SurfaceProperties ( )
inline

Get a writable reference to the SurfaceProperties property.

◆ upd_visible()

bool& OpenSim::Appearance::upd_visible ( )
inline

Get a writable reference to the visible property.

◆ updateFromXMLNode()

void OpenSim::Appearance::updateFromXMLNode ( SimTK::Xml::Element &  aNode,
int  versionNumber 
)
inlineoverrideprotectedvirtual

Updating XML formating to latest revision.

Reimplemented from OpenSim::Object.

References OpenSim::XMLDocument::getLatestVersion().

OpenSim Property, Socket, Output, Input Documentation

◆ color

SimTK::Vec3 OpenSim::Appearance::color

"The color, (red, green, blue), [0, 1], used to display the geometry. "

This property appears in XML files under the tag <color>. This property was generated with the OpenSim_DECLARE_PROPERTY macro; see Property to learn about the property system.

See also
get_color(), upd_color(), set_color()

◆ opacity

double OpenSim::Appearance::opacity

"The opacity used to display the geometry between 0:transparent, 1:opaque."

This property appears in XML files under the tag <opacity>. This property was generated with the OpenSim_DECLARE_PROPERTY macro; see Property to learn about the property system.

See also
get_opacity(), upd_opacity(), set_opacity()

◆ SurfaceProperties

SurfaceProperties OpenSim::Appearance::SurfaceProperties

"Visuals applied to surfaces associated with this Appearance."

This property appears in XML files under the tag <SurfaceProperties>. This property was generated with the OpenSim_DECLARE_UNNAMED_PROPERTY macro; see Property to learn about the property system.

See also
get_SurfaceProperties(), upd_SurfaceProperties(), set_SurfaceProperties()

◆ visible

bool OpenSim::Appearance::visible

"Flag indicating whether the associated Geometry is visible or hidden."

This property appears in XML files under the tag <visible>. This property was generated with the OpenSim_DECLARE_PROPERTY macro; see Property to learn about the property system.

See also
get_visible(), upd_visible(), set_visible()

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