SurgSim::Physics::Computation Class Reference

Encapsulates a calculation over a selection of objects, needs to be subclassed to be used. More...

#include <Computation.h>

Inheritance diagram for SurgSim::Physics::Computation:

Public Member Functions
	Computation (bool doCopyState)
	Constructor. More...
virtual	~Computation ()
	Destructor.
std::shared_ptr< PhysicsManagerState >	update (double dt, const std::shared_ptr< PhysicsManagerState > &state)
	Public Interface execute this objects computations, dt is the time from the last update call in seconds. More...
void	setDoCopyState (bool val)
	Sets up whether the computation will copy the state of PhysicsManagerState before executing. More...
bool	isCopyingState ()
	Query if this object is copying the PhysicsManagerState. More...
virtual std::string	getClassName () const =0
	The class name for this class. More...
Framework::Timer &	getTimer ()
	Provides access to the update timer. More...

Protected Member Functions
virtual std::shared_ptr< PhysicsManagerState >	doUpdate (const double &dt, const std::shared_ptr< PhysicsManagerState > &state)=0
	Override this function to implement the computations specific behavior.

Detailed Description

Encapsulates a calculation over a selection of objects, needs to be subclassed to be used.

Constructor & Destructor Documentation

Computation()

SurgSim::Physics::Computation::Computation ( bool  doCopyState )

explicit

Constructor.

Parameters

doCopyState

Specify if the output state in Computation::Update() is a copy or not of the input state

Member Function Documentation

getClassName()

virtual std::string SurgSim::Physics::Computation::getClassName ( ) const

pure virtual

The class name for this class.

Note

Use the SURGSIM_CLASSNAME macro in derived classes.

Returns

The fully namespace qualified name of this class.

getTimer()

Framework::Timer & SurgSim::Physics::Computation::getTimer

(

)

Provides access to the update timer.

Returns

The timer.

isCopyingState()

bool SurgSim::Physics::Computation::isCopyingState

(

)

Query if this object is copying the PhysicsManagerState.

Returns

true if copying the state, false if not.

setDoCopyState()

void SurgSim::Physics::Computation::setDoCopyState

(

bool

val

)

Sets up whether the computation will copy the state of PhysicsManagerState before executing.

Parameters

val	Whether to create a copy of the PhysicsState before running the update fuction.

update()

std::shared_ptr< PhysicsManagerState > SurgSim::Physics::Computation::update	(	double	dt,
		const std::shared_ptr< PhysicsManagerState > &	state
	)

Public Interface execute this objects computations, dt is the time from the last update call in seconds.

Parameters

dt	The time passed from the last update in seconds.
state	The physics state.

Returns

The changed state of the, depending on the setting of doCopyState this is either the same instance or a copied instance of the physics state.

---

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

• SurgSim/Physics/Computation.h
• SurgSim/Physics/Computation.cpp