This class captures information indicating user or programmer preferences to guide automatic display geometry generation by a Model. More...

Inheritance diagram for OpenSim::ModelDisplayHints:

OpenSim Properties, Sockets, Outputs, Inputs
Properties (single-value)
bool	show_wrap_geometry
	"Flag to indicate whether or not to show wrap geometry, default to true." More...

bool	show_contact_geometry
	"Flag to indicate whether or not to show contact geometry, default to true." More...

bool	show_path_geometry
	"Flag to indicate whether or not to show path geometry for forces and actuators, default to true." More...

bool	show_path_points
	"Flag to indicate whether or not to show points along path are shown, default to true." More...

bool	show_markers
	"Flag to indicate whether or not to show markers, default to true." More...

SimTK::Vec3	marker_color
	"Color is RGB, each components is in the range [0, 1], default to pink." More...

bool	show_forces
	"Flag to indicate whether or not to show forces, default to true." More...

bool	show_frames
	"Flag to indicate whether or not to show frames, default to false." More...

bool	show_labels
	"Flag to indicate whether or not to show labels, default to false." More...

bool	show_debug_geometry
	"Flag to indicate whether or not to show debug geometry, default to false." More...

Public Member Functions
	ModelDisplayHints ()
	Default construction creates a valid display hints object with all hints set to their default values. More...

Property-related functions
const bool &	get_show_wrap_geometry () const
	Get the value of the show_wrap_geometry property. More...

bool &	upd_show_wrap_geometry ()
	Get a writable reference to the show_wrap_geometry property. More...

void	set_show_wrap_geometry (const bool &value)
	Set the value of the show_wrap_geometry property. More...

const bool &	get_show_contact_geometry () const
	Get the value of the show_contact_geometry property. More...

bool &	upd_show_contact_geometry ()
	Get a writable reference to the show_contact_geometry property. More...

void	set_show_contact_geometry (const bool &value)
	Set the value of the show_contact_geometry property. More...

const bool &	get_show_path_geometry () const
	Get the value of the show_path_geometry property. More...

bool &	upd_show_path_geometry ()
	Get a writable reference to the show_path_geometry property. More...

void	set_show_path_geometry (const bool &value)
	Set the value of the show_path_geometry property. More...

const bool &	get_show_path_points () const
	Get the value of the show_path_points property. More...

bool &	upd_show_path_points ()
	Get a writable reference to the show_path_points property. More...

void	set_show_path_points (const bool &value)
	Set the value of the show_path_points property. More...

const bool &	get_show_markers () const
	Get the value of the show_markers property. More...

bool &	upd_show_markers ()
	Get a writable reference to the show_markers property. More...

void	set_show_markers (const bool &value)
	Set the value of the show_markers property. More...

const SimTK::Vec3 &	get_marker_color () const
	Get the value of the marker_color property. More...

SimTK::Vec3 &	upd_marker_color ()
	Get a writable reference to the marker_color property. More...

void	set_marker_color (const SimTK::Vec3 &value)
	Set the value of the marker_color property. More...

const bool &	get_show_forces () const
	Get the value of the show_forces property. More...

bool &	upd_show_forces ()
	Get a writable reference to the show_forces property. More...

void	set_show_forces (const bool &value)
	Set the value of the show_forces property. More...

const bool &	get_show_frames () const
	Get the value of the show_frames property. More...

bool &	upd_show_frames ()
	Get a writable reference to the show_frames property. More...

void	set_show_frames (const bool &value)
	Set the value of the show_frames property. More...

const bool &	get_show_labels () const
	Get the value of the show_labels property. More...

bool &	upd_show_labels ()
	Get a writable reference to the show_labels property. More...

void	set_show_labels (const bool &value)
	Set the value of the show_labels property. More...

const bool &	get_show_debug_geometry () const
	Get the value of the show_debug_geometry property. More...

bool &	upd_show_debug_geometry ()
	Get a writable reference to the show_debug_geometry property. More...

void	set_show_debug_geometry (const bool &value)
	Set the value of the show_debug_geometry 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...

Object &	operator= (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 AbstractProperty &	getPropertyByIndex (int propertyIndex) const
	Get a const reference to a property by its index number, returned as an AbstractProperty. More...

AbstractProperty &	updPropertyByIndex (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 AbstractProperty &	getPropertyByName (const std::string &name) const
	Get a const reference to a property by its name, returned as an AbstractProperty. More...

AbstractProperty &	updPropertyByName (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...

virtual void	updateFromXMLNode (SimTK::Xml::Element &objectElement, int versionNumber)
	Use this method to deserialize an object from a SimTK::Xml::Element. 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...

PropertySet &	getPropertySet ()
	OBSOLETE: Get a reference to the PropertySet maintained by the Object. More...

const PropertySet &	getPropertySet () const

Auto-generated functions
static ModelDisplayHints *	safeDownCast (OpenSim::Object *obj)
	For use in MATLAB and Python to access the concrete class. More...

static const std::string &	getClassName ()
	This returns "ModelDisplayHints". More...

ModelDisplayHints *	clone () 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 Object *	getDefaultInstanceOfType (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 Object *	newInstanceOfType (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 Object *	makeObjectFromFile (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 amount of logging output. More...

static int	getDebugLevel ()
	Get the current setting of debug level. More...

static Object *	SafeCopy (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...

Detailed Description

This class captures information indicating user or programmer preferences to guide automatic display geometry generation by a Model.

Fields here may be set programmatically or as a result of user choices made in the GUI or ModelVisualizer. Any display-generating code including the GUI, ModelVisualizer, and any geometry-generating ModelComponent will be supplied with one of these so that it can modify its behavior if there are any fields it recognizes.

If you are writing a ModelComponent that generates some of its own geometry, and you would like people to consider it well-behaved, you should check whether any of the flags here might reasonably be expected to affect the geometry that your component produces. The currently-supported flags are:

show wrap geometry
show contact geometry
show muscle paths (should apply to other path objects too)
show path points
show markers
show forces
show frames
show labels
show debug geometry

This class is intended to provide some minimal user control over generated geometry in a form that is easy for a ModelComponent author to deal with, since the OpenSim user interface won't know anything about that component or its geometry. Nothing prevents a user interface from providing much more sophisticated control of display features that it understands and the OpenSim GUI does that.

If you would like to see some additional generally-useful flags or options supported here, please file a feature request or post to the OpenSim forum on SimTK.org.

Note: The "set" methods here return a reference to the object so they can be chained for convenience like assignment statements.

See also: ModelComponent::generateDecorations(), ModelVisualizer

Author: Michael Sherman

Constructor & Destructor Documentation

◆ ModelDisplayHints()

OpenSim::ModelDisplayHints::ModelDisplayHints ( )

inline

Default construction creates a valid display hints object with all hints set to their default values.

Member Function Documentation

◆ clone()

ModelDisplayHints* OpenSim::ModelDisplayHints::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_marker_color()

const SimTK::Vec3& OpenSim::ModelDisplayHints::get_marker_color ( ) const

inline

Get the value of the marker_color property.

◆ get_show_contact_geometry()

const bool& OpenSim::ModelDisplayHints::get_show_contact_geometry ( ) const

inline

Get the value of the show_contact_geometry property.

◆ get_show_debug_geometry()

const bool& OpenSim::ModelDisplayHints::get_show_debug_geometry ( ) const

inline

Get the value of the show_debug_geometry property.

◆ get_show_forces()

const bool& OpenSim::ModelDisplayHints::get_show_forces ( ) const

inline

Get the value of the show_forces property.

◆ get_show_frames()

const bool& OpenSim::ModelDisplayHints::get_show_frames ( ) const

inline

Get the value of the show_frames property.

◆ get_show_labels()

const bool& OpenSim::ModelDisplayHints::get_show_labels ( ) const

inline

Get the value of the show_labels property.

◆ get_show_markers()

const bool& OpenSim::ModelDisplayHints::get_show_markers ( ) const

inline

Get the value of the show_markers property.

◆ get_show_path_geometry()

const bool& OpenSim::ModelDisplayHints::get_show_path_geometry ( ) const

inline

Get the value of the show_path_geometry property.

◆ get_show_path_points()

const bool& OpenSim::ModelDisplayHints::get_show_path_points ( ) const

inline

Get the value of the show_path_points property.

◆ get_show_wrap_geometry()

const bool& OpenSim::ModelDisplayHints::get_show_wrap_geometry ( ) const

inline

Get the value of the show_wrap_geometry property.

◆ getClassName()

static const std::string& OpenSim::ModelDisplayHints::getClassName ( )

inlinestatic

This returns "ModelDisplayHints".

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

◆ getConcreteClassName()

const std::string& OpenSim::ModelDisplayHints::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 ModelDisplayHints* OpenSim::ModelDisplayHints::safeDownCast ( OpenSim::Object * obj )

inlinestatic

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

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

◆ set_marker_color()

void OpenSim::ModelDisplayHints::set_marker_color ( const SimTK::Vec3 & value )

inline

Set the value of the marker_color property.

◆ set_show_contact_geometry()

void OpenSim::ModelDisplayHints::set_show_contact_geometry ( const bool & value )

inline

Set the value of the show_contact_geometry property.

◆ set_show_debug_geometry()

void OpenSim::ModelDisplayHints::set_show_debug_geometry ( const bool & value )

inline

Set the value of the show_debug_geometry property.

◆ set_show_forces()

void OpenSim::ModelDisplayHints::set_show_forces ( const bool & value )

inline

Set the value of the show_forces property.

◆ set_show_frames()

void OpenSim::ModelDisplayHints::set_show_frames ( const bool & value )

inline

Set the value of the show_frames property.

◆ set_show_labels()

void OpenSim::ModelDisplayHints::set_show_labels ( const bool & value )

inline

Set the value of the show_labels property.

◆ set_show_markers()

void OpenSim::ModelDisplayHints::set_show_markers ( const bool & value )

inline

Set the value of the show_markers property.

◆ set_show_path_geometry()

void OpenSim::ModelDisplayHints::set_show_path_geometry ( const bool & value )

inline

Set the value of the show_path_geometry property.

◆ set_show_path_points()

void OpenSim::ModelDisplayHints::set_show_path_points ( const bool & value )

inline

Set the value of the show_path_points property.

◆ set_show_wrap_geometry()

void OpenSim::ModelDisplayHints::set_show_wrap_geometry ( const bool & value )

inline

Set the value of the show_wrap_geometry property.

◆ upd_marker_color()

SimTK::Vec3& OpenSim::ModelDisplayHints::upd_marker_color ( )

inline

Get a writable reference to the marker_color property.

◆ upd_show_contact_geometry()

bool& OpenSim::ModelDisplayHints::upd_show_contact_geometry ( )

inline

Get a writable reference to the show_contact_geometry property.

◆ upd_show_debug_geometry()

bool& OpenSim::ModelDisplayHints::upd_show_debug_geometry ( )

inline

Get a writable reference to the show_debug_geometry property.

◆ upd_show_forces()

bool& OpenSim::ModelDisplayHints::upd_show_forces ( )

inline

Get a writable reference to the show_forces property.

◆ upd_show_frames()

bool& OpenSim::ModelDisplayHints::upd_show_frames ( )

inline

Get a writable reference to the show_frames property.

◆ upd_show_labels()

bool& OpenSim::ModelDisplayHints::upd_show_labels ( )

inline

Get a writable reference to the show_labels property.

◆ upd_show_markers()

bool& OpenSim::ModelDisplayHints::upd_show_markers ( )

inline

Get a writable reference to the show_markers property.

◆ upd_show_path_geometry()

bool& OpenSim::ModelDisplayHints::upd_show_path_geometry ( )

inline

Get a writable reference to the show_path_geometry property.

◆ upd_show_path_points()

bool& OpenSim::ModelDisplayHints::upd_show_path_points ( )

inline

Get a writable reference to the show_path_points property.

◆ upd_show_wrap_geometry()

bool& OpenSim::ModelDisplayHints::upd_show_wrap_geometry ( )

inline

Get a writable reference to the show_wrap_geometry property.

OpenSim Property, Socket, Output, Input Documentation

◆ marker_color

SimTK::Vec3 OpenSim::ModelDisplayHints::marker_color

"Color is RGB, each components is in the range [0, 1], default to pink."

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

See also: get_marker_color(), upd_marker_color(), set_marker_color()

◆ show_contact_geometry

bool OpenSim::ModelDisplayHints::show_contact_geometry

"Flag to indicate whether or not to show contact geometry, default to true."

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

See also: get_show_contact_geometry(), upd_show_contact_geometry(), set_show_contact_geometry()

◆ show_debug_geometry

bool OpenSim::ModelDisplayHints::show_debug_geometry

"Flag to indicate whether or not to show debug geometry, default to false."

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

See also: get_show_debug_geometry(), upd_show_debug_geometry(), set_show_debug_geometry()

◆ show_forces

bool OpenSim::ModelDisplayHints::show_forces

"Flag to indicate whether or not to show forces, default to true."

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

See also: get_show_forces(), upd_show_forces(), set_show_forces()

◆ show_frames

bool OpenSim::ModelDisplayHints::show_frames

"Flag to indicate whether or not to show frames, default to false."

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

See also: get_show_frames(), upd_show_frames(), set_show_frames()

◆ show_labels

bool OpenSim::ModelDisplayHints::show_labels

"Flag to indicate whether or not to show labels, default to false."

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

See also: get_show_labels(), upd_show_labels(), set_show_labels()

◆ show_markers

bool OpenSim::ModelDisplayHints::show_markers

"Flag to indicate whether or not to show markers, default to true."

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

See also: get_show_markers(), upd_show_markers(), set_show_markers()

◆ show_path_geometry

bool OpenSim::ModelDisplayHints::show_path_geometry

"Flag to indicate whether or not to show path geometry for forces and actuators, default to true."

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

See also: get_show_path_geometry(), upd_show_path_geometry(), set_show_path_geometry()

◆ show_path_points

bool OpenSim::ModelDisplayHints::show_path_points

"Flag to indicate whether or not to show points along path are shown, default to true."

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

See also: get_show_path_points(), upd_show_path_points(), set_show_path_points()

◆ show_wrap_geometry

bool OpenSim::ModelDisplayHints::show_wrap_geometry

"Flag to indicate whether or not to show wrap geometry, default to true."

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

See also: get_show_wrap_geometry(), upd_show_wrap_geometry(), set_show_wrap_geometry()

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

OpenSim/Common/ModelDisplayHints.h

OpenSim Properties, Sockets, Outputs, Inputs

Public Member Functions

Auto-generated functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ ModelDisplayHints()

Member Function Documentation

◆ clone()

◆ get_marker_color()

◆ get_show_contact_geometry()

◆ get_show_debug_geometry()

◆ get_show_forces()

◆ get_show_frames()

◆ get_show_labels()

◆ get_show_markers()

◆ get_show_path_geometry()

◆ get_show_path_points()

◆ get_show_wrap_geometry()

◆ getClassName()

◆ getConcreteClassName()

◆ safeDownCast()

◆ set_marker_color()

◆ set_show_contact_geometry()

◆ set_show_debug_geometry()

◆ set_show_forces()

◆ set_show_frames()

◆ set_show_labels()

◆ set_show_markers()

◆ set_show_path_geometry()

◆ set_show_path_points()

◆ set_show_wrap_geometry()

◆ upd_marker_color()

◆ upd_show_contact_geometry()

◆ upd_show_debug_geometry()

◆ upd_show_forces()

◆ upd_show_frames()

◆ upd_show_labels()

◆ upd_show_markers()

◆ upd_show_path_geometry()

◆ upd_show_path_points()

◆ upd_show_wrap_geometry()

OpenSim Property, Socket, Output, Input Documentation

◆ marker_color

◆ show_contact_geometry

◆ show_debug_geometry

◆ show_forces

◆ show_frames

◆ show_labels

◆ show_markers

◆ show_path_geometry

◆ show_path_points

◆ show_wrap_geometry