SimTK::Visualizer::FrameController Class Reference

This abstract class represents an object that will be invoked by the Visualizer just prior to rendering each frame. More...

#include <Visualizer.h>

List of all members.

Public Member Functions
virtual void	generateControls (const Visualizer &viz, const State &state, Array_< DecorativeGeometry > &geometry)=0
	The Visualizer is just about to generate and render a frame corresponding to the given State.
virtual	~FrameController ()
	Destructor is virtual; be sure to override it if you have something to clean up at the end.

---

Detailed Description

This abstract class represents an object that will be invoked by the Visualizer just prior to rendering each frame.

You can use this to call any of the const (runtime) methods of the Visualizer, typically to control the camera, and you can also add some geometry to the scene, print messages to the console, and so on.

---

Constructor & Destructor Documentation

virtual SimTK::Visualizer::FrameController::~FrameController

(

)

[inline, virtual]

Destructor is virtual; be sure to override it if you have something to clean up at the end.

---

Member Function Documentation

virtual void SimTK::Visualizer::FrameController::generateControls	(	const Visualizer &	viz,
		const State &	state,
		Array_< DecorativeGeometry > &	geometry
	)		[pure virtual]

The Visualizer is just about to generate and render a frame corresponding to the given State.

Parameters:

[in]	viz	The Visualizer that is doing the rendering.
[in]	state	The State that is being used to generate the frame about to be rendered by viz.
[in,out]	geometry	DecorativeGeometry being accumulated for rendering in this frame; be sure to append if you have anything to add.

---

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

• Visualizer.h