#include <ObjectMovement.h>

Inheritance diagram for APEditorQAbilities::ObjectMovement:

Classes
struct	CANDIDATEPLANE

class	SnapBox

Public Member Functions
	ObjectMovement ()

virtual	~ObjectMovement ()

virtual bool	initialize (XERCES_CPP_NAMESPACE_QUALIFIER DOMNode *parameters=NULL)

virtual void	update (void)

Public Member Functions inherited from vrecko::ControllableAbility
	ControllableAbility (const char *abilityName)

virtual	~ControllableAbility ()

virtual bool	isActive ()
	It shouldn't be necessary to override this function. More...

Public Member Functions inherited from vrecko::Ability
virtual	~Ability ()
	copy constructor More...

const std::string &	getName () const
	Returns the ability name. More...

void	setPluginName (const char *pName)
	Sets the plugin name. More...

const std::string &	getPluginName (void) const
	Returns the plugin name. More...

const std::string &	getID (void) const
	Returns ability the identification string. More...

void	setID (const char *pID)
	(Internal usage, most people should not need to use it.) Sets the ability ID. More...

virtual void	clean (void)

void	setOwner (BaseClass *owner)
	(Internal usage, most people should not need to use it.) Sets ability owner. *l This method is called automatically in World::createAbility(), so one would (almost?) never want to use it directly. More...

BaseClass *	getOwner (void)
	Returns the ability owner. More...

virtual ParameterVector *	getParameterVector (void)
	Return vector of the parameter description. More...

bool	isUpdated (void)
	Set update flag. More...

virtual const std::string &	getSenderString (void)
	Returns the identification string of sender. More...

Public Member Functions inherited from vrecko::BaseClass
	BaseClass (const char *startingSenderString)
	The main constructor. More...

	BaseClass (BaseClass &bc)
	Copy constructor. Probably not really used. More...

virtual	~BaseClass ()
	Destructor. More...

virtual bool	initializeFromString (const char *xmlString)
	Helper method that allows to initialize ability from a XML-formatted string. More...

virtual XERCES_CPP_NAMESPACE_QUALIFIER DOMNode *	saveXMLParameters (XERCES_CPP_NAMESPACE_QUALIFIER DOMDocument *)
	Save current setting into a XML node. More...

bool	inputPresent (const std::string &name)
	Returns true if input pin (not request inputpin ) with given name is present. More...

bool	outputPresent (const std::string &name)
	Returns true if output pin (not request output pin) with given name is present. More...

void	addInputPin (InputPinBase *pin)
	Adds an input pin. More...

void	removeInputPin (InputPinBase *pin)
	Removes an input pin. More...

void	addOutputPin (OutputPinBase *pin)
	Adds an output pin. More...

void	removeOutputPin (OutputPinBase *pin)
	Removes and output pin. More...

void	addRequestInputPin (RequestInputPinBase *pin)
	Adds a request input pin. More...

void	removeRequestInputPin (RequestInputPinBase *pin)
	Removes a request input pin. More...

void	addRequestOutputPin (RequestOutputPinBase *pin)
	Adds a request output pin. More...

void	removeRequestOutputPin (RequestOutputPinBase *pin)
	Removes a request output pin. More...

bool	addNotification (BaseClass *receiver, unsigned long notificationTypes)
	Registers an observer that will be notified if a specific change occurs. More...

bool	removeNotification (BaseClass *receiver, unsigned long notificationTypes=NOTIFICATION_ALL)
	Unregisters a previously registered observer. More...

virtual void	processEvent (const std::string &input_name, VreckoMessage *pMessage)
	Internal method for processing the events. More...

virtual VreckoMessage *	processRequest (const std::string &request_input_name, VreckoMessage *pMessage)
	Internal method for processing the requests. More...

void	reportError (const std::string &error)
	Print error message. More...

void	setPriority (long int pr)
	Sets the priority. (Possible problems - read the full description for more info) More...

long int	getPriority (void) const
	Returns current object priority. More...

void	setAttribute (const std::string &attr_name, int attr_value)
	Sets an attribute value. More...

int	getAttribute (const std::string &attr_name)
	Returns attribute value. More...

int	getAttribute (const char *attr_name)
	Returns attribute value. More...

void	deleteAttribute (const std::string &attr_name)
	Delete an attribute. More...

void	setSceneFile (const std::string &sceneFileName)
	Set the name of the file this component was in (and possibly will be saved to). More...

const std::string &	getSceneFile () const
	Get the name of the file this component was in. More...

virtual bool	loadXMLParameters (const char *xmlString)
	OBSOLETE METHOD, kept for backwards compatibility. More...

InputPinBase *	getInputPin (const char *strName)
	Returns pointer to an input pin with specified name. More...

OutputPinBase *	getOutputPin (const char *strName)
	Returns pointer to an output pin with specified name. More...

RequestInputPinBase *	getRequestInputPin (const char *strName)
	Returns pointer to an request input pin with specified name. More...

RequestOutputPinBase *	getRequestOutputPin (const char *strName)
	Returns pointer to an input pin with specified name. More...

Protected Types
enum	CandidatePlaneType { Other = 0, Horizontal_PrioritySnap }

Protected Member Functions
virtual CAINFO *	createInfo ()

virtual void	fillDefaultInfo ()

virtual bool	activate ()

virtual void	deactivate ()

bool	objectTransformationFromPointer (EnvironmentObject eo, osg::Matrix outTrans)

bool	applySnapping (EnvironmentObject eo, osg::Matrix inoutTrans)

bool	addSnappingPlane (unsigned long objectID, unsigned long objectSide, osg::Vec3 &center, osg::Vec3 &normal, osg::Vec3 &halfVec1, osg::Vec3 &halfVec2, osg::Vec3 shiftVec, float shiftLen2, osg::Vec3 &snapPoint, float halfRect1SnapMul, float halfRect2SnapMul, float fMinU, float fMaxU, float fMinV, float fMaxV, CandidatePlaneType type)

bool	isPlaneCompatibleWithSelectedSet (int iPlaneIndex)

bool	calcFinalShiftFromSelectedSet (osg::Vec3 &outShift, int additionalPlane=-1)

bool	intersect2Planes (osg::Vec3 &p1p, osg::Vec3 &p1normal, osg::Vec3 &p2p, osg::Vec3 &p2normal, osg::Vec3 &outLineStart, osg::Vec3 &outLineDir)

bool	intersectLinePlane (osg::Vec3 &lineStart, osg::Vec3 &lineDir, osg::Vec3 &planePoint, osg::Vec3 &planeNormal, osg::Vec3 &outPoint)

bool	projectPointOnPlaneUV (osg::Vec3 &point, osg::Vec3 &planePoint, osg::Vec3 &planeNormal, osg::Vec3 &halfVec1, osg::Vec3 &halfVec2, osg::Vec3 outProjectedPoint, float outDist, float outU, float outV)

Protected Member Functions inherited from vrecko::ControllableAbility
virtual void	createInterface ()

virtual void	destroyInterface ()

virtual void	processButtonPress (CABUTTONEVENT *eventData)

virtual void	processButtonRelease (CABUTTONEVENT *eventData)

virtual int	processNotification (BaseClass sender, unsigned long notificationType, void notificationData)

bool	requestPointerLoc (bool bCancelIfNotActive=true)

bool	requestPointerLocRaw (bool bCancelIfNotActive=true)

bool	requestSelectionID (bool bCancelIfNotActive=true)

bool	requestSelectionPath (bool bCancelIfNotActive=true)

bool	isMenuCreated ()

bool	isMenuVisible ()

virtual bool	createMenu (const char *menuString, bool bForceCreate=true)

virtual void	destroyMenu ()

virtual bool	showMenu ()

virtual bool	hideMenu ()

virtual void	processMenuButtonPress (CABUTTONEVENT *eventData)

virtual void	processMenuButtonRelease (CABUTTONEVENT *eventData)

virtual void	menuItemClicked (const char *itemID)

virtual void	menuSliderChanged (const char *sliderID, float sliderPos)

	DECLARE_INPUT (ButtonStateChange, MessageCAButtonEvent)

	DECLARE_INPUT (Menu_Clicked, MessageString)

	DECLARE_REQUEST_INPUT (ActivePointerID, MessageInt, MessageInt)

	DECLARE_REQUEST_INPUT (GetInfo, MessageVoid, MessageCAINFO)

	DECLARE_REQUEST_OUTPUT (PointerPos, MessageInt, MessageVec3)

	DECLARE_REQUEST_OUTPUT (PointerRot, MessageInt, MessageQuat)

	DECLARE_REQUEST_OUTPUT (PointerPosRaw, MessageInt, MessageVec3)

	DECLARE_REQUEST_OUTPUT (PointerRotRaw, MessageInt, MessageQuat)

	DECLARE_REQUEST_OUTPUT (SelectionID, MessageInt, MessageObjectID)

	DECLARE_REQUEST_OUTPUT (SelectionPath, MessageInt, MessageNodeList)

Protected Member Functions inherited from vrecko::Ability
	Ability (const char *theAbilityName)

Protected Member Functions inherited from vrecko::BaseClass
bool	sendNotifications (unsigned long notificationType, void *notificationData)

IOPinBase *	findPinInList (const char strName, PinList pinList)
	Internal method to find a given pin in a given list. More...

Protected Attributes
bool	bApplySnapping

bool	bIgnoreRotation

osg::Vec3	firstPointerPos

osg::Quat	firstPointerRot

osg::Vec3	firstObjectPos

osg::Quat	firstObjectRot

unsigned long	movingObjectID

bool	bFirstUpdate

DynamicArray< SnapBox >	snapBoxes

osg::BoundingBox	objAABox

osg::Matrix	objAABoxTrans

osg::ref_ptr< EnvironmentObject >	shadowObject

Ability *	objectEffect

DynamicArray< CANDIDATEPLANE >	planes

DynamicArray< DWORD >	selectedPlanes

Protected Attributes inherited from vrecko::ControllableAbility
EnvironmentObject *	owner
	The owner object. More...

int	activePointerID
	Active pointer ID or 0 if not active. More...

int	lastEventButtonID
	ID of a button that was received in the last button press/release event. More...

osg::Vec3	actPointerPos

osg::Vec3	actPointerPosRaw

osg::Quat	actPointerRot

osg::Quat	actPointerRotRaw

unsigned long	actSelectedObjectID

std::vector< osg::Node * > *	actSelectedPath

int	actPosInPath

CAINFO	defaultInfo

Ability *	menu

bool	bMenuVisible

Protected Attributes inherited from vrecko::Ability
BaseClass *	pOwner
	Pointer to the owner of this ability. (Almost?) always an EnvironmentObject class. More...

std::vector< std::string >	parameterString

bool	updated
	Update flag. It is used for save. More...

Protected Attributes inherited from vrecko::BaseClass
AttributeMap	attribute

MTReadWriteLock	attributeLock

std::string	senderString

MTLock	notificationsLock

std::vector < NOTIFICATION_DESCRIPTION >	notifications

long int	priority

const std::string *	sceneFile

PinList	inputPinsList

PinList	outputPinsList

PinList	requestInputPinsList

PinList	requestOutputPinsList

Friends
int	planesCompare (const ObjectMovement::CANDIDATEPLANE elem1, const ObjectMovement::CANDIDATEPLANE elem2)

Additional Inherited Members
Public Types inherited from vrecko::Ability
typedef std::vector < ParameterStruct >	ParameterVector
	Vector of the description of parameters. More...

Member Enumeration Documentation

enum APEditorQAbilities::ObjectMovement::CandidatePlaneType

protected

Enumerator
Other
Horizontal_PrioritySnap

Constructor & Destructor Documentation

APEditorQAbilities::ObjectMovement::ObjectMovement ( )

virtual APEditorQAbilities::ObjectMovement::~ObjectMovement ( )

inlinevirtual

Member Function Documentation

bool APEditorQAbilities::ObjectMovement::activate ( )

protectedvirtual

Called when the ability is about to be activated. Returns true if the ability is activated or false otherwise (so the activation will be cancelled). CAN/SHOULD be overriden to activate the ability properly, but should call the ancestor method and return "false" if the ancestor returned false too.

Reimplemented from vrecko::ControllableAbility.

bool APEditorQAbilities::ObjectMovement::addSnappingPlane	(	unsigned long	objectID,
		unsigned long	objectSide,
		osg::Vec3 &	center,
		osg::Vec3 &	normal,
		osg::Vec3 &	halfVec1,
		osg::Vec3 &	halfVec2,
		osg::Vec3	shiftVec,
		float	shiftLen2,
		osg::Vec3 &	snapPoint,
		float	halfRect1SnapMul,
		float	halfRect2SnapMul,
		float	fMinU,
		float	fMaxU,
		float	fMinV,
		float	fMaxV,
		CandidatePlaneType	type
	)

protected

bool APEditorQAbilities::ObjectMovement::applySnapping	(	EnvironmentObject *	eo,
		osg::Matrix *	inoutTrans
	)

protected

bool APEditorQAbilities::ObjectMovement::calcFinalShiftFromSelectedSet	(	osg::Vec3 &	outShift,
		int	additionalPlane = `-1`
	)

protected

CAINFO * APEditorQAbilities::ObjectMovement::createInfo ( )

protectedvirtual

        This method creates a new instance of the CAINFO structure and copies data
        from the [defaltInfo] structure. Additionally, it may change
        some of the parameters of the new structure (especially [dwActiveFlags]).

        CAN be overridden although it is unnecessary in most cases.
        The overridden method should look like this:

        You have complete control over the structure, but some field have
        been already pre-filled: Especially size and some the [dwActiveFlags].
        The [dwActiveFlags] has been changed according to the current state of the ability
        (is Menu displayed -> prefer not to show the selections etc.)
        You can still change any of the attributes.

        CAINFO* info = ControllableAbility::createInfo();
        if (!info)
            return NULL;

Now adjust the members of the structure. Note: If adjusting for example info->dwActiveFlags for selection visibility, ... // you have to use the mask. For example, to set the visibility to _ACTPTR_FORCESHOW: info->dwActiveFlags = CAINFO_AFLAGS_SELSHOW_ACTPTR_FORCESHOW | (info->dwActiveFlags & ~CAINFO_AFLAGS_SELSHOW_ACTPTR__MASK);

        return info;

Reimplemented from vrecko::ControllableAbility.

void APEditorQAbilities::ObjectMovement::deactivate ( )

protectedvirtual

Called when the ability is about to be deactivated. CAN be overridden to unlock used objects etc., but should call the ancestor method. You may wan to call isActive() in the overriden method to check whether the ability is really being deactivated.

Reimplemented from vrecko::ControllableAbility.

void APEditorQAbilities::ObjectMovement::fillDefaultInfo ( )

protectedvirtual

MUST be overridden. The overridden method have to fill in the [defaultInfo]. The structure is already filled by zeroes and the size is set correctly, so you need to only change what is necessary. The [defaultInfo] is used as a base information that will be used in createInfo() method. The createInfo() may adjust some of the parameters and you can adjust it even further by overriding createInfo().

Implements vrecko::ControllableAbility.

bool APEditorQAbilities::ObjectMovement::initialize ( XERCES_CPP_NAMESPACE_QUALIFIER DOMNode * parameters = NULL )

virtual

Called as the first initialization method COULD be overridden, but it HAS TO CALL the method from the ancestor class. But BETTER SOLUTION is to override the createInterface() and destroyInterface() functions instead.

Reimplemented from vrecko::ControllableAbility.

bool APEditorQAbilities::ObjectMovement::intersect2Planes	(	osg::Vec3 &	p1p,
		osg::Vec3 &	p1normal,
		osg::Vec3 &	p2p,
		osg::Vec3 &	p2normal,
		osg::Vec3 &	outLineStart,
		osg::Vec3 &	outLineDir
	)

protected

bool APEditorQAbilities::ObjectMovement::intersectLinePlane	(	osg::Vec3 &	lineStart,
		osg::Vec3 &	lineDir,
		osg::Vec3 &	planePoint,
		osg::Vec3 &	planeNormal,
		osg::Vec3 &	outPoint
	)

protected

bool APEditorQAbilities::ObjectMovement::isPlaneCompatibleWithSelectedSet ( int iPlaneIndex )

protected

bool APEditorQAbilities::ObjectMovement::objectTransformationFromPointer	(	EnvironmentObject *	eo,
		osg::Matrix *	outTrans
	)

protected

bool APEditorQAbilities::ObjectMovement::projectPointOnPlaneUV	(	osg::Vec3 &	point,
		osg::Vec3 &	planePoint,
		osg::Vec3 &	planeNormal,
		osg::Vec3 &	halfVec1,
		osg::Vec3 &	halfVec2,
		osg::Vec3 *	outProjectedPoint,
		float *	outDist,
		float *	outU,
		float *	outV
	)

protected

void APEditorQAbilities::ObjectMovement::update ( void )

virtual

Called by the VRECKO scheduler at the specified frequency. CAN be overridden, but it HAS TO CALL the method from the ancestor class. (For future updates)

Reimplemented from vrecko::ControllableAbility.

Friends And Related Function Documentation

int planesCompare	(	const ObjectMovement::CANDIDATEPLANE *	elem1,
		const ObjectMovement::CANDIDATEPLANE *	elem2
	)

friend

Member Data Documentation

bool APEditorQAbilities::ObjectMovement::bApplySnapping

protected

bool APEditorQAbilities::ObjectMovement::bFirstUpdate

protected

bool APEditorQAbilities::ObjectMovement::bIgnoreRotation

protected

osg::Vec3 APEditorQAbilities::ObjectMovement::firstObjectPos

protected

osg::Quat APEditorQAbilities::ObjectMovement::firstObjectRot

protected

osg::Vec3 APEditorQAbilities::ObjectMovement::firstPointerPos

protected

osg::Quat APEditorQAbilities::ObjectMovement::firstPointerRot

protected

unsigned long APEditorQAbilities::ObjectMovement::movingObjectID

protected

osg::BoundingBox APEditorQAbilities::ObjectMovement::objAABox

protected

osg::Matrix APEditorQAbilities::ObjectMovement::objAABoxTrans

protected

Ability* APEditorQAbilities::ObjectMovement::objectEffect

protected

DynamicArray<CANDIDATEPLANE> APEditorQAbilities::ObjectMovement::planes

protected

DynamicArray<DWORD> APEditorQAbilities::ObjectMovement::selectedPlanes

protected

osg::ref_ptr<EnvironmentObject> APEditorQAbilities::ObjectMovement::shadowObject

protected

DynamicArray<SnapBox> APEditorQAbilities::ObjectMovement::snapBoxes

protected

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

C:/Documents/School/OSG/VRECKO/include/vreckoAP/EditorQAbilities/ObjectMovement.h
C:/Documents/School/OSG/VRECKO/src/vreckoAP/EditorQAbilities/ObjectMovement.cpp

Classes

Public Member Functions

Protected Types

Protected Member Functions

Protected Attributes

Friends

Additional Inherited Members

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation

Friends And Related Function Documentation

Member Data Documentation