OpenSim::DisplayGeometry Class Reference

A class for representing the DisplayGeometry properties of an object. More...

#include <DisplayGeometry.h>

Inheritance diagram for OpenSim::DisplayGeometry:
OpenSim::Object

List of all members.

Public Types

enum  DisplayPreference {
  None = 0, WireFrame = 1, SolidFill = 2, FlatShaded = 3,
  GouraudShaded = 4
}

Public Member Functions

 DisplayGeometry ()
 A class for representing one DisplayGeometry of an object, e.g.
 DisplayGeometry (const std::string &aFileName)
 DisplayGeometry (const DisplayGeometry &aDisplayGeometry)
 Copy constructor.
virtual ~DisplayGeometry ()
virtual Objectcopy () const
 Construct and return a copy of this object.
DisplayGeometryoperator= (const DisplayGeometry &aObject)
 Assignment operator.
bool operator== (const DisplayGeometry &aObject) const
 Determine if two objects are equal.
const std::string & getGeometryFile () const
void setGeometryFile (const std::string &aGeometryFile)
SimTK::Vec3 & getColor () const
void getColor (double aColor[3])
void setColor (const SimTK::Vec3 &aColor)
void setColor (double aColor[3])
const std::string & getTextureFile () const
void setTextureFile (const std::string &aTextureFile)
SimTK::Transform & getTransform () const
void setTransform (const SimTK::Transform &aTransform)
void setRotationsAndTRanslations (double aArray[])
void getRotationsAndTranslationsAsArray6 (double aArray[]) const
SimTK::Vec3 & getScaleFactors () const
void getScaleFactors (double aScaleFactors[]) const
void setScaleFactors (const double aScaleFactors[])
void setScaleFactors (const SimTK::Vec3 &aScaleFactors)
DisplayPreference getDisplayPreference () const
void setDisplayPreference (const DisplayPreference &aPreference)
double getOpacity () const
void setOpacity (const double &aOpacity)
 OPENSIM_DECLARE_DERIVED (DisplayGeometry, Object)

Protected Member Functions

virtual void setupProperties ()
 Connect properties to local pointers.

Protected Attributes

PropertyStr _propGeometryFile
 Name of geomtry file .vtp, .stl, .obj are supported.
std::string & _geometryFile
PropertyDblVec3 _propColor
 A list of 3 colors.
SimTK::Vec3 & _color
PropertyDbl _propOpacity
 Opacity.
double & _opacity
PropertyStr _propTextureFile
 Texture file.
std::string & _textureFile
PropertyTransform _propTransform
 Transform relative to owner's frame.
SimTK::Transform & _transform
PropertyDblVec3 _propScaleFactors
 A list of 3 scale factors in X, Y, Z directions.
SimTK::Vec3 & _scaleFactors
PropertyInt _propDisplayPreference
 DisplayPreference 0 up to 4.
DisplayPreference_displayPreference

Detailed Description

A class for representing the DisplayGeometry properties of an object.

Author:
Ayman Habib
Version:
1.0

Member Enumeration Documentation

Enumerator:
None 
WireFrame 
SolidFill 
FlatShaded 
GouraudShaded 

Constructor & Destructor Documentation

DisplayGeometry::DisplayGeometry (  ) 

A class for representing one DisplayGeometry of an object, e.g.

one bone

Author:
Ayman Habib
Version:
1.0 Default constructor.
DisplayGeometry::DisplayGeometry ( const std::string &  aFileName  ) 
DisplayGeometry::DisplayGeometry ( const DisplayGeometry aGeometryPiece  ) 

Copy constructor.

Parameters:
aGeometryPiece DisplayGeometry to be copied.
virtual OpenSim::DisplayGeometry::~DisplayGeometry (  )  [inline, virtual]

Member Function Documentation

Object * DisplayGeometry::copy (  )  const [virtual]

Construct and return a copy of this object.

The object is allocated using the new operator, so the caller is responsible for deleting the returned object.

Returns:
Copy of this object.

Reimplemented from OpenSim::Object.

void OpenSim::DisplayGeometry::getColor ( double  aColor[3]  )  [inline]
SimTK::Vec3& OpenSim::DisplayGeometry::getColor (  )  const [inline]
DisplayPreference OpenSim::DisplayGeometry::getDisplayPreference (  )  const [inline]
const std::string& OpenSim::DisplayGeometry::getGeometryFile (  )  const [inline]
double OpenSim::DisplayGeometry::getOpacity (  )  const [inline]
void OpenSim::DisplayGeometry::getRotationsAndTranslationsAsArray6 ( double  aArray[]  )  const [inline]
void OpenSim::DisplayGeometry::getScaleFactors ( double  aScaleFactors[]  )  const [inline]
SimTK::Vec3& OpenSim::DisplayGeometry::getScaleFactors (  )  const [inline]
const std::string& OpenSim::DisplayGeometry::getTextureFile (  )  const [inline]
SimTK::Transform& OpenSim::DisplayGeometry::getTransform (  )  const [inline]
OpenSim::DisplayGeometry::OPENSIM_DECLARE_DERIVED ( DisplayGeometry  ,
Object   
)
DisplayGeometry & DisplayGeometry::operator= ( const DisplayGeometry aDisplayGeometry  ) 

Assignment operator.

Returns:
Reference to this object.

Reimplemented from OpenSim::Object.

bool OpenSim::DisplayGeometry::operator== ( const DisplayGeometry aObject  )  const [inline, virtual]

Determine if two objects are equal.

Returns:
True if the two objects are equal, false otherwise.

Reimplemented from OpenSim::Object.

void OpenSim::DisplayGeometry::setColor ( double  aColor[3]  )  [inline]
void OpenSim::DisplayGeometry::setColor ( const SimTK::Vec3 &  aColor  )  [inline]
void OpenSim::DisplayGeometry::setDisplayPreference ( const DisplayPreference aPreference  )  [inline]
void OpenSim::DisplayGeometry::setGeometryFile ( const std::string &  aGeometryFile  )  [inline]
void OpenSim::DisplayGeometry::setOpacity ( const double &  aOpacity  )  [inline]
void DisplayGeometry::setRotationsAndTRanslations ( double  aArray[]  ) 
void OpenSim::DisplayGeometry::setScaleFactors ( const SimTK::Vec3 &  aScaleFactors  )  [inline]
void OpenSim::DisplayGeometry::setScaleFactors ( const double  aScaleFactors[]  )  [inline]
void OpenSim::DisplayGeometry::setTextureFile ( const std::string &  aTextureFile  )  [inline]
void OpenSim::DisplayGeometry::setTransform ( const SimTK::Transform &  aTransform  )  [inline]
void DisplayGeometry::setupProperties ( void   )  [protected, virtual]

Connect properties to local pointers.

Reimplemented from OpenSim::Object.


Member Data Documentation

SimTK::Vec3& OpenSim::DisplayGeometry::_color [protected]
std::string& OpenSim::DisplayGeometry::_geometryFile [protected]

A list of 3 colors.

DisplayPreference 0 up to 4.

Name of geomtry file .vtp, .stl, .obj are supported.

Opacity.

A list of 3 scale factors in X, Y, Z directions.

Texture file.

Transform relative to owner's frame.

SimTK::Vec3& OpenSim::DisplayGeometry::_scaleFactors [protected]
std::string& OpenSim::DisplayGeometry::_textureFile [protected]
SimTK::Transform& OpenSim::DisplayGeometry::_transform [protected]

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

Generated on Sun Sep 25 00:19:47 2011 for OpenSim by  doxygen 1.6.1