VTKVisualizer Class Reference

#include <VTKVisualizer.h>

List of all members.

Public Member Functions
	VTKVisualizer ()
	VTKVisualizer (const MultibodySystem &m)
	VTKVisualizer (const VTKVisualizer &)
	~VTKVisualizer ()
VTKVisualizer &	operator= (const VTKVisualizer &)
void	report (const State &s) const
	This method calculates a new visualization frame using the MultibodySystem and the supplied state, and updates the screen.
void	setCameraLocation (const Vec3 &)
	Change the camera location. This is a point in the Ground frame.
void	setCameraFocalPoint (const Vec3 &)
	Change the point towards which the camera is pointing.
void	setCameraUpDirection (const Vec3 &)
	Change the camera's "up" direction.
void	setCameraClippingRange (Real nearPlane, Real farPlane)
	Set the location of the clipping planes.
void	zoomCameraToIncludeAllGeometry ()
	Zoom the camera so that all geometry is visible.
void	zoomCamera (Real)
	Zoom by an amount relative to the current zoom.
void	addDecoration (MobilizedBodyIndex, const Transform &X_BD, const DecorativeGeometry &)
	Add an always-present, body-fixed piece of geometry like the one passed in, but attached to the indicated body.
void	addRubberBandLine (MobilizedBodyIndex b1, const Vec3 &station1, MobilizedBodyIndex b2, const Vec3 &station2, const DecorativeLine &)
	Add an always-present rubber band line, modeled after the DecorativeLine supplied here.
void	addEphemeralDecoration (const DecorativeGeometry &)
	Add a piece of geometry to the next frame only.
bool	isOwnerHandle () const
	Is this handle the owner of this rep? This is true if the handle is empty or if its rep points back here.
bool	isEmptyHandle () const
	VTKVisualizer (class VTKVisualizerRep *r)
bool	hasRep () const
const VTKVisualizerRep &	getRep () const
VTKVisualizerRep &	updRep () const
Protected Attributes
class VTKVisualizerRep *	rep

---

Constructor & Destructor Documentation

VTKVisualizer

(

)

[inline]

VTKVisualizer

(

const MultibodySystem &

m

)

[explicit]

VTKVisualizer

(

const VTKVisualizer &

)

~VTKVisualizer

(

)

VTKVisualizer

(

class VTKVisualizerRep *

r

)

[inline, explicit]

---

Member Function Documentation

VTKVisualizer& operator=

(

const VTKVisualizer &

)

void report

(

const State &

s

)

const

This method calculates a new visualization frame using the MultibodySystem and the supplied state, and updates the screen.

Referenced by main().

void setCameraLocation

(

const Vec3 &

)

Change the camera location. This is a point in the Ground frame.

void setCameraFocalPoint

(

const Vec3 &

)

Change the point towards which the camera is pointing.

This point is in the Ground frame.

void setCameraUpDirection

(

const Vec3 &

)

Change the camera's "up" direction.

This is a vector in the ground frame; only its direction is meaningful.

void setCameraClippingRange	(	Real	nearPlane,
		Real	farPlane
	)

Set the location of the clipping planes.

These planes are perpendicular to the view plane normal, which is a vector in the direction from the camera location to the camera focal point. Their locations are given by distances along the the view plane normal, measured from the camera position.

void zoomCameraToIncludeAllGeometry

(

)

Zoom the camera so that all geometry is visible.

void zoomCamera

(

Real

)

Zoom by an amount relative to the current zoom.

void addDecoration	(	MobilizedBodyIndex	,
		const Transform &	X_BD,
		const DecorativeGeometry &
	)

Add an always-present, body-fixed piece of geometry like the one passed in, but attached to the indicated body.

The supplied transform is applied on top of whatever transform is already contained in the supplied geometry, and any body Id stored with the geometry is ignored. The 3d representation of the geometry here can be precalculated; only the orientation of the body frame needs to be applied at run time.

void addRubberBandLine	(	MobilizedBodyIndex	b1,
		const Vec3 &	station1,
		MobilizedBodyIndex	b2,
		const Vec3 &	station2,
		const DecorativeLine &
	)

Add an always-present rubber band line, modeled after the DecorativeLine supplied here.

The end points of the supplied line are ignored, however -- at run time we'll calculate the spatial locations of the two supplied stations and use those as end points. Note that the 3d representation of this line can't be precalculated because the line length will vary.

void addEphemeralDecoration

(

const DecorativeGeometry &

)

Add a piece of geometry to the next frame only.

The bodies, transforms, etc. are pulled from the argument, and the geometry is generated immediately and added to the current frame. Then it is discarded.

bool isOwnerHandle

(

)

const

Is this handle the owner of this rep? This is true if the handle is empty or if its rep points back here.

bool isEmptyHandle

(

)

const

bool hasRep

(

)

const [inline]

const VTKVisualizerRep& getRep

(

)

const [inline]

VTKVisualizerRep& updRep

(

)

const [inline]

---

Member Data Documentation

class VTKVisualizerRep* rep [protected]

---

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

• VTKVisualizer.h