SIM_ForceReferenceFrame Class Reference

#include <SIM_ForceReferenceFrame.h>

Inheritance diagram for SIM_ForceReferenceFrame:

List of all members.

Public Member Functions
	GET_DATA_FUNC_S ("newframeobject", NewFrameName)
	The object to get the new frame from.
	GETSET_DATA_FUNCS_I (SIM_NAME_SAMPLEMODE, SampleMode)
	Whether to sample by point, circle, or sphere.
Protected Member Functions
	SIM_ForceReferenceFrame (const SIM_DataFactory *factory)
virtual	~SIM_ForceReferenceFrame ()
virtual void	getForceSubclass (const SIM_Object &object, const UT_Vector3 &position, const UT_Vector3 &velocity, const UT_Vector3 &angvel, const fpreal mass, UT_Vector3 &force, UT_Vector3 &torque) const
virtual SIM_ForceSample	getOptimalForceSamplingSubclass () const

---

Detailed Description

This is an implementation of the SIM_Force interface. This implementation transforms the accerations of another object into forces on this object, thereby allowing you to have an object use another object as a reference frame.

Definition at line 26 of file SIM_ForceReferenceFrame.h.

---

Constructor & Destructor Documentation

SIM_ForceReferenceFrame::SIM_ForceReferenceFrame

(

const SIM_DataFactory *

factory

)

[explicit, protected]

virtual SIM_ForceReferenceFrame::~SIM_ForceReferenceFrame

(

)

[protected, virtual]

---

Member Function Documentation

SIM_ForceReferenceFrame::GET_DATA_FUNC_S	(	"newframeobject"	,
		NewFrameName
	)

The object to get the new frame from.

virtual void SIM_ForceReferenceFrame::getForceSubclass	(	const SIM_Object &	object,
		const UT_Vector3 &	position,
		const UT_Vector3 &	velocity,
		const UT_Vector3 &	angvel,
		const fpreal	mass,
		UT_Vector3 &	force,
		UT_Vector3 &	torque
	)			const [protected, virtual]

Computes the acceleration of the frame object and uses that to determine fictitious forces that would generate that acceleration. These become the returned force.

Reimplemented from SIM_Force.

virtual SIM_ForceSample SIM_ForceReferenceFrame::getOptimalForceSamplingSubclass

(

)

const [protected, virtual]

Allows solvers to query what the optimal sampling type for this force would be. Solvers do not have to respect this. This should be user overrideable so users can trade efficiency for accuracy.

Reimplemented from SIM_Force.

SIM_ForceReferenceFrame::GETSET_DATA_FUNCS_I	(	SIM_NAME_SAMPLEMODE	,
		SampleMode
	)

Whether to sample by point, circle, or sphere.

---

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

• SIM/SIM_ForceReferenceFrame.h