![]() |
API
3.3
|
This class captures information indicating user or programmer preferences to guide automatic display geometry generation by a Model. More...
Public Member Functions | |
ModelDisplayHints () | |
Default construction creates a valid display hints object with all hints set to their default values. More... | |
void | clear () |
This method sets all the display hints to their default values. More... | |
Methods for specifying what should get displayed | |
ModelDisplayHints & | setShowWrapGeometry (bool showWrap) |
Specify whether wrap geometry should be displayed. More... | |
bool | getShowWrapGeometry () const |
Return current setting of the "show wrap geometry" flag. More... | |
ModelDisplayHints & | setShowContactGeometry (bool showContact) |
Specify whether contact geometry should be displayed. More... | |
bool | getShowContactGeometry () const |
Return current setting of the "show contact geometry" flag. More... | |
ModelDisplayHints & | setShowMusclePaths (bool showMusclePaths) |
Specify whether muscle path lines (or path lines for other path-using components like ligaments) should be displayed. More... | |
bool | getShowMusclePaths () const |
Return current setting of the "show muscle paths" flag. More... | |
ModelDisplayHints & | setShowPathPoints (bool showPathPoints) |
Specify whether path points should appear along muscle paths in the display. More... | |
bool | getShowPathPoints () const |
Return current setting of the "show path points" flag. More... | |
ModelDisplayHints & | setShowMarkers (bool showMarkers) |
Specify whether marker points should be displayed. More... | |
bool | getShowMarkers () const |
Return current setting of the "show markers" flag. More... | |
ModelDisplayHints & | setShowForces (bool showForces) |
Specify whether forces should be generated and displayed. More... | |
bool | getShowForces () const |
Return current setting of the "show forces" flag. More... | |
ModelDisplayHints & | setShowFrames (bool showFrames) |
Specify whether coordinate frames should be displayed. More... | |
bool | getShowFrames () const |
Return current setting of the "show frames" flag. More... | |
ModelDisplayHints & | setShowLabels (bool showLabels) |
Specify whether text labels should be generated and displayed. More... | |
bool | getShowLabels () const |
Return current setting of the "show labels" flag. More... | |
ModelDisplayHints & | setShowDebugGeometry (bool showDebugGeometry) |
Specify whether debug geometry should be generated and displayed. More... | |
bool | getShowDebugGeometry () const |
Return current setting of the "show debug geometry" flag. More... | |
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:
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.
|
inline |
Default construction creates a valid display hints object with all hints set to their default values.
References clear().
|
inline |
This method sets all the display hints to their default values.
Referenced by ModelDisplayHints().
|
inline |
Return current setting of the "show contact geometry" flag.
|
inline |
Return current setting of the "show debug geometry" flag.
|
inline |
Return current setting of the "show forces" flag.
|
inline |
Return current setting of the "show frames" flag.
|
inline |
Return current setting of the "show labels" flag.
|
inline |
Return current setting of the "show markers" flag.
|
inline |
Return current setting of the "show muscle paths" flag.
|
inline |
Return current setting of the "show path points" flag.
|
inline |
Return current setting of the "show wrap geometry" flag.
|
inline |
Specify whether contact geometry should be displayed.
The default is yes.
|
inline |
Specify whether debug geometry should be generated and displayed.
The default is no.
|
inline |
Specify whether forces should be generated and displayed.
This may apply to forces applied by a component, or calculated reaction forces. The default is no.
|
inline |
Specify whether coordinate frames should be displayed.
The default is no.
|
inline |
Specify whether text labels should be generated and displayed.
The default is no.
|
inline |
Specify whether marker points should be displayed.
The default is yes.
|
inline |
Specify whether muscle path lines (or path lines for other path-using components like ligaments) should be displayed.
The default is yes.
|
inline |
Specify whether path points should appear along muscle paths in the display.
The default is yes but has no effect if muscle paths are not being displayed.
|
inline |
Specify whether wrap geometry should be displayed.
The default is yes.