SIM_ConAnchorObjSpatial Class Reference

#include <SIM_ConAnchorObjSpatial.h>

Inheritance diagram for SIM_ConAnchorObjSpatial:

List of all members.

Public Member Functions
	GETSET_DATA_FUNCS_S (SIM_NAME_OBJECT, ObjectName)
	GETSET_DATA_FUNCS_V3 (SIM_NAME_OFFSET, OffsetInput)
	Object-space offset.
	GETSET_DATA_FUNCS_V3 (SIM_NAME_WORLDSPACEPOS, WorldSpacePosition)
	GETSET_DATA_FUNCS_B (SIM_NAME_USEWORLDSPACEPOS, UseWorldSpacePosition)
const UT_Vector3	getOffset () const
	Overridable get/set for Offset.
void	setOffset (const UT_Vector3 &vector)
Protected Member Functions
	SIM_ConAnchorObjSpatial (const SIM_DataFactory *f)
virtual	~SIM_ConAnchorObjSpatial ()
virtual bool	getNeedsInitSubclass () const
virtual void	initAnchorSubclass (const SIM_Object *object)
virtual bool	getObjectSpecificationSubclass (UT_String &str) const
	Implements the real functionality of getObjectSpecification.
void	initParmsFromWorldSpacePosition (const UT_Vector3 &worldspacepos, const SIM_Object *object)
virtual void	initParmsFromWorldSpacePositionSubclass (const UT_Vector3 &worldspacepos, const SIM_Object *object)=0
virtual const UT_Vector3	getOffsetSubclass () const

---

Detailed Description

Definition at line 21 of file SIM_ConAnchorObjSpatial.h.

---

Constructor & Destructor Documentation

SIM_ConAnchorObjSpatial::SIM_ConAnchorObjSpatial

(

const SIM_DataFactory *

f

)

[explicit, protected]

virtual SIM_ConAnchorObjSpatial::~SIM_ConAnchorObjSpatial

(

)

[protected, virtual]

---

Member Function Documentation

virtual bool SIM_ConAnchorObjSpatial::getNeedsInitSubclass

(

)

const [protected, virtual]

Returns true if the anchor needs to have initAnchor() called. The default implementation returns false.

Reimplemented from SIM_ConAnchor.

virtual bool SIM_ConAnchorObjSpatial::getObjectSpecificationSubclass

(

UT_String &

str

)

const [protected, virtual]

Implements the real functionality of getObjectSpecification.

Reimplemented from SIM_ConAnchor.

const UT_Vector3 SIM_ConAnchorObjSpatial::getOffset

(

)

const

Overridable get/set for Offset.

virtual const UT_Vector3 SIM_ConAnchorObjSpatial::getOffsetSubclass

(

)

const [protected, virtual]

SIM_ConAnchorObjSpatial::GETSET_DATA_FUNCS_B	(	SIM_NAME_USEWORLDSPACEPOS	,
		UseWorldSpacePosition
	)

This value must be true to force the constraint to initialize itself from the provided world space position. Otherwise the constraint-specific parameters are used directly.

SIM_ConAnchorObjSpatial::GETSET_DATA_FUNCS_S	(	SIM_NAME_OBJECT	,
		ObjectName
	)

SIM_ConAnchorObjSpatial::GETSET_DATA_FUNCS_V3	(	SIM_NAME_WORLDSPACEPOS	,
		WorldSpacePosition
	)

This value represents the desired world-space position of the constraint. Every spatial constraint must be able to initialize itself using this world space position.

SIM_ConAnchorObjSpatial::GETSET_DATA_FUNCS_V3	(	SIM_NAME_OFFSET	,
		OffsetInput
	)

Object-space offset.

virtual void SIM_ConAnchorObjSpatial::initAnchorSubclass

(

const SIM_Object *

object

)

[protected, virtual]

Initializes the anchor for use by a solver. The default implementation does nothing.

Reimplemented from SIM_ConAnchor.

void SIM_ConAnchorObjSpatial::initParmsFromWorldSpacePosition	(	const UT_Vector3 &	worldspacepos,
		const SIM_Object *	object
	)			[protected]

virtual void SIM_ConAnchorObjSpatial::initParmsFromWorldSpacePositionSubclass	(	const UT_Vector3 &	worldspacepos,
		const SIM_Object *	object
	)			[protected, pure virtual]

Implemented in SIM_ConAnchorObjPointPos, SIM_ConAnchorObjPrimPos, and SIM_ConAnchorObjSpacePos.

void SIM_ConAnchorObjSpatial::setOffset

(

const UT_Vector3 &

vector

)

---

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

• SIM/SIM_ConAnchorObjSpatial.h