SIM_ForcePoint Class Reference

#include <SIM_ForcePoint.h>

Inheritance diagram for SIM_ForcePoint:

List of all members.

Public Member Functions
	GETSET_DATA_FUNCS_V3 (SIM_NAME_FORCE, Force)
	Control the force attribute.
	GETSET_DATA_FUNCS_V3 (SIM_NAME_POSITION, ForcePosition)
	Control the position attribute.
	GETSET_DATA_FUNCS_I (SIM_NAME_SAMPLEMODE, SampleMode)
	Whether to sample by point, circle, or sphere.
Protected Member Functions
	SIM_ForcePoint (const SIM_DataFactory *factory)
virtual	~SIM_ForcePoint ()
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 applies a force in a given direction from a given point. This means the torque will take into account the offset from the center of mass.

Definition at line 25 of file SIM_ForcePoint.h.

---

Constructor & Destructor Documentation

SIM_ForcePoint::SIM_ForcePoint

(

const SIM_DataFactory *

factory

)

[explicit, protected]

virtual SIM_ForcePoint::~SIM_ForcePoint

(

)

[protected, virtual]

---

Member Function Documentation

virtual void SIM_ForcePoint::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]

Returns the force and torque on a point. The returned values are the torque and force applied to an object with center of mass at poistion which receives a force at PointPosition of value ForcePoint. The getForceOnCircleSubclass() and getForceOnSphereSubclass() functions use the default implementations which scale the point force by the area or volume of the circle or sphere. This means that regardless of the size of samples used to quantize an object, the total force on the object should remain roughly constant.

Reimplemented from SIM_Force.

virtual SIM_ForceSample SIM_ForcePoint::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_ForcePoint::GETSET_DATA_FUNCS_I	(	SIM_NAME_SAMPLEMODE	,
		SampleMode
	)

Whether to sample by point, circle, or sphere.

SIM_ForcePoint::GETSET_DATA_FUNCS_V3	(	SIM_NAME_POSITION	,
		ForcePosition
	)

Control the position attribute.

SIM_ForcePoint::GETSET_DATA_FUNCS_V3	(	SIM_NAME_FORCE	,
		Force
	)

Control the force attribute.

---

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

• SIM/SIM_ForcePoint.h