#include <Camera.h>

Inheritance diagram for APCameraPath::Camera:

Public Member Functions
	Camera ()

virtual	~Camera ()

void	update (void)

virtual bool	initialize (XERCES_CPP_NAMESPACE_QUALIFIER DOMNode *parameters=NULL)

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	state { STATE_EDITING, STATE_ANIMATING, STATE_MOVING }

enum	animate { ANIM_1ST_VIEW, ANIM_3RD_VIEW }

Protected Member Functions
virtual void	fillDefaultInfo ()

virtual bool	activate ()

virtual void	deactivate ()

virtual void	menuItemClicked (const char *itemID)

bool	loadXMLParameters (XERCES_CPP_NAMESPACE_QUALIFIER DOMNode *pParametersNode)

void	ComputePath (std::vector< ControlPoint > &ControlPoints, osg::Vec3Array Path, osg::Vec3Array View)

void	ComputeSpline (const std::vector< osg::Vec3 > &PointList, osg::Vec3Array arrayToStorePoints, bool bDynamicSpeed, const std::vector< double > LengthsOfParts)

std::vector< double >	ArcLength (osg::Vec3Array *PointList, int PointsOnPart=100)

void	DrawSpline (vrecko::EnvironmentObject pCurveOwner, osg::Vec3Array PointSet, osg::Vec4 colorOfLine)

void	CreateCurs2ViewPts ()

void	DrawVecCursor (vrecko::EnvironmentObject *pCursorOwner, double dVecLength, const osg::Matrix &rotationMatrix, osg::Vec3 &position)

vrecko::EnvironmentObject *	DrawPoint (osg::Vec3 position, float pointRadius, osg::Vec4 pointColor)

void	UpdatePath ()

void	InitAnimation (osg::Vec3Array path, osg::Vec3Array view)

void	Animate ()

osg::Matrix	Orient2Vec (osg::Vec3 Vector)

bool	makeMenu ()

bool	makeMovementMenu ()

bool	FindPoint (double dDistance, osg::Vec3Array PointList, osg::Vec3Array newControlPoints)

void	Clear ()

void	Init ()

void	AddPathPoint (osg::Vec3 position)

void	AddViewPoint (osg::Vec3 position)

void	DeletePoint (unsigned long ID)

void	start1stAnimation ()

void	SaveAnimation (const char *FileName)

bool	LoadAnimation (const char *FileName, std::vector< osg::Vec3 > &newPathControlPoints, std::vector< osg::Vec3 > &newViewControlPoints)

void	issueRequests (bool bStopIfNoSelection)

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

void	UpdateMove ()

bool	ActivateMove ()

void	DeactivateMove ()

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)

virtual CAINFO *	createInfo ()

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	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
enum APCameraPath::Camera::state	m_eState

enum APCameraPath::Camera::animate	m_eAnimate

vrecko::World::AvatarView	avView

vrecko::EnvironmentObject *	m_pEOPathLine

vrecko::EnvironmentObject *	m_pEOPathPoints

vrecko::EnvironmentObject *	m_pEOViewLine

vrecko::EnvironmentObject *	m_pEOCursor

vrecko::EnvironmentObject *	m_pEOCamera

bool	bStartAnimation

bool	b3rdCamera

unsigned int	m_numOfViewPts

std::vector< ControlPoint >	m_ControlPoints

std::vector< osg::Vec3 >	m_ActPathLine

std::vector< osg::Vec3 >	m_ActViewLine

float	fPointRadius

bool	bShowViewLine

bool	bShowLinesWhileAnim

int	iSpeed

float	fTransparency

float	fAnimationTime

string	sAnimationFile

bool	bAnimationFile

bool	bAutoRun

bool	bDynamicSpeed

std::vector< osg::Vec3 >	PathCtrlPts

std::vector< osg::Vec3 >	ViewCtrlPts

osg::Vec3	firstPointerPos

osg::Vec3	firstObjectPos

unsigned long	movingObjectID

bool	bFirstUpdate

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

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 APCameraPath::Camera::animate

protected

Enumerator
ANIM_1ST_VIEW
ANIM_3RD_VIEW

enum APCameraPath::Camera::state

protected

Enumerator
STATE_EDITING
STATE_ANIMATING
STATE_MOVING

Constructor & Destructor Documentation

APCameraPath::Camera::Camera ( )

virtual APCameraPath::Camera::~Camera ( )

inlinevirtual

Member Function Documentation

bool APCameraPath::Camera::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 APCameraPath::Camera::ActivateMove ( )

protected

void APCameraPath::Camera::AddPathPoint ( osg::Vec3 position )

protected

void APCameraPath::Camera::AddViewPoint ( osg::Vec3 position )

protected

void APCameraPath::Camera::Animate ( )

protected

std::vector< double > APCameraPath::Camera::ArcLength	(	osg::Vec3Array *	PointList,
		int	PointsOnPart = `100`
	)

protected

Computes length of each spline segment created by "PointsOnPart" points(default is 100 points);

void APCameraPath::Camera::Clear ( )

protected

Clear all

void APCameraPath::Camera::ComputePath	(	std::vector< ControlPoint > &	ControlPoints,
		osg::Vec3Array *	Path,
		osg::Vec3Array *	View
	)

protected

void APCameraPath::Camera::ComputeSpline	(	const std::vector< osg::Vec3 > &	PointList,
		osg::Vec3Array *	arrayToStorePoints,
		bool	bDynamicSpeed,
		const std::vector< double > *	LengthsOfParts
	)

protected

Catmull-rom algorithm implementation for creating a spline

void APCameraPath::Camera::CreateCurs2ViewPts ( )

protected

Create and draw a 3D pointer from each path control point to each view control point

void APCameraPath::Camera::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 APCameraPath::Camera::DeactivateMove ( )

protected

void APCameraPath::Camera::DeletePoint ( unsigned long ID )

protected

EnvironmentObject * APCameraPath::Camera::DrawPoint	(	osg::Vec3	position,
		float	pointRadius,
		osg::Vec4	pointColor
	)

protected

Draw a point of given radius and color, return pointer to EO

void APCameraPath::Camera::DrawSpline	(	vrecko::EnvironmentObject *	pCurveOwner,
		osg::Vec3Array *	PointSet,
		osg::Vec4	colorOfLine
	)

protected

void APCameraPath::Camera::DrawVecCursor	(	vrecko::EnvironmentObject *	pCursorOwner,
		double	dVecLength,
		const osg::Matrix &	rotationMatrix,
		osg::Vec3 &	position
	)

protected

Draw a cursor pointing to view point

void APCameraPath::Camera::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 APCameraPath::Camera::FindPoint	(	double	dDistance,
		osg::Vec3Array *	PointList,
		osg::Vec3Array *	newControlPoints
	)

protected

Finds all points in accurate length in given PointList and store them to 'newControlPoints'structure

void APCameraPath::Camera::Init ( )

protected

void APCameraPath::Camera::InitAnimation	(	osg::Vec3Array *	path,
		osg::Vec3Array *	view
	)

protected

Initialization and animation processing

virtual bool APCameraPath::Camera::initialize ( XERCES_CPP_NAMESPACE_QUALIFIER DOMNode * parameters = NULL )

inlinevirtual

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.

void APCameraPath::Camera::issueRequests ( bool bStopIfNoSelection )

protected

bool APCameraPath::Camera::LoadAnimation	(	const char *	FileName,
		std::vector< osg::Vec3 > &	newPathControlPoints,
		std::vector< osg::Vec3 > &	newViewControlPoints
	)

protected

bool APCameraPath::Camera::loadXMLParameters ( XERCES_CPP_NAMESPACE_QUALIFIER DOMNode * pParametersNode )

protectedvirtual

Use initialize() instead.

In "private" section, so basically hidden as well as possible, so others cannot use it.

Reimplemented from vrecko::ControllableAbility.

bool APCameraPath::Camera::makeMenu ( )

protected

Base menu

bool APCameraPath::Camera::makeMovementMenu ( )

protected

Menu for disabling point movement

void APCameraPath::Camera::menuItemClicked ( const char * itemID )

protectedvirtual

This method should be overridden for the menu to work. The [itemID] could be NULL in case the user hasn't clicked on any item. (It is expected that the menu will disappear.) If [itemID] is a valid pointer, it will contain the name (not caption) of the item clicked.

Reimplemented from vrecko::ControllableAbility.

bool APCameraPath::Camera::objectTransformationFromPointer	(	vrecko::EnvironmentObject *	eo,
		osg::Matrix *	outTrans
	)

protected

osg::Matrix APCameraPath::Camera::Orient2Vec ( osg::Vec3 Vector )

protected

Return a Matrix for rotation to specific vector (Orientation of object is computed for +Z)

void APCameraPath::Camera::SaveAnimation ( const char * FileName )

protected

void APCameraPath::Camera::start1stAnimation ( )

protected

void APCameraPath::Camera::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.

void APCameraPath::Camera::UpdateMove ( )

protected

void APCameraPath::Camera::UpdatePath ( )

protected

Updates every CameraPath object in scene

Member Data Documentation

vrecko::World::AvatarView APCameraPath::Camera::avView

protected

bool APCameraPath::Camera::b3rdCamera

protected

bool APCameraPath::Camera::bAnimationFile

protected

bool APCameraPath::Camera::bAutoRun

protected

bool APCameraPath::Camera::bDynamicSpeed

protected

bool APCameraPath::Camera::bFirstUpdate

protected

bool APCameraPath::Camera::bShowLinesWhileAnim

protected

bool APCameraPath::Camera::bShowViewLine

protected

bool APCameraPath::Camera::bStartAnimation

protected

float APCameraPath::Camera::fAnimationTime

protected

osg::Vec3 APCameraPath::Camera::firstObjectPos

protected

osg::Vec3 APCameraPath::Camera::firstPointerPos

protected

float APCameraPath::Camera::fPointRadius

protected

float APCameraPath::Camera::fTransparency

protected

int APCameraPath::Camera::iSpeed

protected

std::vector<osg::Vec3> APCameraPath::Camera::m_ActPathLine

protected

std::vector<osg::Vec3> APCameraPath::Camera::m_ActViewLine

protected

std::vector<ControlPoint> APCameraPath::Camera::m_ControlPoints

protected

enum APCameraPath::Camera::animate APCameraPath::Camera::m_eAnimate

protected

enum APCameraPath::Camera::state APCameraPath::Camera::m_eState

protected

unsigned int APCameraPath::Camera::m_numOfViewPts

protected

vrecko::EnvironmentObject* APCameraPath::Camera::m_pEOCamera

protected

vrecko::EnvironmentObject* APCameraPath::Camera::m_pEOCursor

protected

vrecko::EnvironmentObject* APCameraPath::Camera::m_pEOPathLine

protected

vrecko::EnvironmentObject* APCameraPath::Camera::m_pEOPathPoints

protected

vrecko::EnvironmentObject* APCameraPath::Camera::m_pEOViewLine

protected

unsigned long APCameraPath::Camera::movingObjectID

protected

std::vector<osg::Vec3> APCameraPath::Camera::PathCtrlPts

protected

string APCameraPath::Camera::sAnimationFile

protected

std::vector<osg::Vec3> APCameraPath::Camera::ViewCtrlPts

protected

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

C:/Documents/School/OSG/VRECKO/include/vreckoAP/CameraPath/Camera.h
C:/Documents/School/OSG/VRECKO/src/vreckoAP/CameraPath/Camera.cpp

Public Member Functions

Protected Types

Protected Member Functions

Protected Attributes

Additional Inherited Members

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation