Simbody  3.3
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
SimTK::DecorativePoint Class Reference

A point of interest. More...

#include <DecorativeGeometry.h>

+ Inheritance diagram for SimTK::DecorativePoint:

Public Member Functions

 DecorativePoint (const Vec3 &p=Vec3(0))
 
DecorativePointsetPoint (const Vec3 &p)
 
const Vec3getPoint () const
 
DecorativePointsetBodyId (int b)
 
DecorativePointsetTransform (const Transform &X_BD)
 
DecorativePointsetResolution (Real r)
 
DecorativePointsetScaleFactors (const Vec3 &s)
 
DecorativePointsetColor (const Vec3 &rgb)
 
DecorativePointsetOpacity (Real o)
 
DecorativePointsetLineThickness (Real t)
 
DecorativePointsetRepresentation (const Representation &r)
 
 SimTK_PIMPL_DOWNCAST (DecorativePoint, DecorativeGeometry)
 
- Public Member Functions inherited from SimTK::DecorativeGeometry
 DecorativeGeometry ()
 
 ~DecorativeGeometry ()
 
 DecorativeGeometry (const DecorativeGeometry &)
 
DecorativeGeometryoperator= (const DecorativeGeometry &)
 
DecorativeGeometrysetBodyId (int)
 By default the geometry will be placed on ground. More...
 
DecorativeGeometrysetTransform (const Transform &X_BG)
 This transform shifts the generated polygons with respect to this object's local frame. More...
 
DecorativeGeometrysetResolution (Real)
 Each concrete DecorativeGeometry object is expected to have a default resolution that gets the point across but is cheap to draw and hence probably somewhat "chunky". More...
 
DecorativeGeometrysetScaleFactors (const Vec3 &scale)
 Each concrete DecorativeGeometry object is expected to have a default size around "1", whatever that means for a particular object, and most objects also allow a user-specified size on construction. More...
 
DecorativeGeometrysetScale (Real scale)
 Convenience method to set all three scale factors to the same value. More...
 
int getBodyId () const
 Return the body to which this geometry is attached. More...
 
Real getResolution () const
 Return the current setting of the "resolution" factor. More...
 
const TransformgetTransform () const
 Return the current value of the object's transform. More...
 
const Vec3getScaleFactors () const
 Return the current setting of the "scale" factors. More...
 
DecorativeGeometrysetColor (const Vec3 &rgb)
 Request a specific color for this DecorativeGeometry object. More...
 
DecorativeGeometrysetOpacity (Real)
 Request a level of transparency for this DecorativeGeometry. More...
 
DecorativeGeometrysetLineThickness (Real)
 Request an adjustment to the default rendering of lines and curves. More...
 
const Vec3getColor () const
 Return the color specified for this object, if any, otherwise Vec3(-1) indicating that the default color will be used. More...
 
Real getOpacity () const
 Return the opacity specified for this object. More...
 
Real getLineThickness () const
 Return the line thickness specified for this object, if any, otherwise return -1 to indicate that the default line thickness should be used. More...
 
DecorativeGeometrysetFaceCamera (int shouldFace)
 Set whether the geometry acts as a billboard, always rotating to face the camera. More...
 
int getFaceCamera () const
 Get whether the geometry acts as a billboard, always rotating to face the camera. More...
 
DecorativeGeometrysetRepresentation (const Representation &)
 Request a particular rendering representation of this DecorativeGeometry object. More...
 
Representation getRepresentation () const
 Returns drawing mode: -1 means "use default"; see above for others. More...
 
void implementGeometry (DecorativeGeometryImplementation &) const
 
bool isOwnerHandle () const
 
bool isEmptyHandle () const
 
 DecorativeGeometry (class DecorativeGeometryRep *r)
 
bool hasRep () const
 
const DecorativeGeometryRep & getRep () const
 
DecorativeGeometryRep & updRep ()
 

Additional Inherited Members

- Public Types inherited from SimTK::DecorativeGeometry
enum  Representation {
  DrawPoints = 1,
  DrawWireframe = 2,
  DrawSurface = 3,
  DrawDefault = -1
}
 
- Protected Attributes inherited from SimTK::DecorativeGeometry
DecorativeGeometryRep * rep
 

Detailed Description

A point of interest.

Note that the point's location is given relative to the DecorativeGeometry frame so it will move if the geometry is transformed when attached somewhere or displayed. The default constructor will put the point at (0,0,0).

Constructor & Destructor Documentation

SimTK::DecorativePoint::DecorativePoint ( const Vec3 p = Vec3(0))
explicit

Member Function Documentation

DecorativePoint& SimTK::DecorativePoint::setPoint ( const Vec3 p)
const Vec3& SimTK::DecorativePoint::getPoint ( ) const
DecorativePoint& SimTK::DecorativePoint::setBodyId ( int  b)
inline
DecorativePoint& SimTK::DecorativePoint::setTransform ( const Transform X_BD)
inline
DecorativePoint& SimTK::DecorativePoint::setResolution ( Real  r)
inline
DecorativePoint& SimTK::DecorativePoint::setScaleFactors ( const Vec3 s)
inline
DecorativePoint& SimTK::DecorativePoint::setColor ( const Vec3 rgb)
inline
DecorativePoint& SimTK::DecorativePoint::setOpacity ( Real  o)
inline
DecorativePoint& SimTK::DecorativePoint::setLineThickness ( Real  t)
inline
DecorativePoint& SimTK::DecorativePoint::setRepresentation ( const Representation r)
inline
SimTK::DecorativePoint::SimTK_PIMPL_DOWNCAST ( DecorativePoint  ,
DecorativeGeometry   
)

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