CYISceneNodeProxy Class Reference

Detailed Description

A class used to proxy access to a CYISceneNode.

Instances of this class are used to provide access to a CYISceneNode instance when the lifetime of that scene node is unknown. The CYISceneNodeProxy instances are accessed from a CYISceneNode instance and held in a shared pointer. If the scene node instance is deleted, the proxy instance is updated and its scene node reference is set to nullptr. Subsequent calls to setters on the proxy will have no effect.

Note

This class provides safe CYISceneNode wrapper functions, ensuring the CYISceneNode instance is valid before dereferencing it.

This class is never instanciated. Objects of this class are actually CYIEventTargetProxy instances (converted from CYIEventTargetProxy to CYISceneNodeProxy via static cast), therefore this class must only provide new member functions, not data members.

See also

CYIEventTarget::GetProxy()

CYISceneNode::GetSceneNodeProxy()

#include <scenetree/YiSceneNodeProxy.h>

Inheritance diagram for CYISceneNodeProxy:

Public Member Functions
const CYISceneNode *	GetSceneNode () const
CYISceneNode *	GetSceneNode ()
void	SetAnchorPoint (const glm::vec3 &ref)
void	SetAnchorPoint (float x, float y, float z)
void	SetAnchorPointX (float x)
void	SetAnchorPointY (float y)
void	SetAnchorPointZ (float z)
void	SetPosition (const glm::vec3 &ref)
void	SetPosition (float x, float y, float z)
void	SetPositionX (float x)
void	SetPositionY (float y)
void	SetPositionZ (float z)
void	SetRotation (const glm::vec3 &eulerDegrees)
void	SetRotation (float pitchDegrees, float yawDegrees, float rollDegrees)
void	SetRotationX (float pitchDegrees)
void	SetRotationY (float yawDegrees)
void	SetRotationZ (float rollDegrees)
void	SetOrientation (float pitchDegrees, float yawDegrees, float rollDegrees)
void	SetOrientation (const glm::quat &orient)
void	SetScale (const glm::vec3 &scaleFactors)
void	SetScale (float factorX, float factorY, float factorZ)
void	SetScaleX (float factor)
void	SetScaleY (float factor)
void	SetScaleZ (float factor)
void	Show ()
void	Hide ()
void	SetOpacity (float opacity)
void	SetInternalCustomTimelineValue (uint32_t trackID, const CYIVariant &value)
Public Member Functions inherited from CYIEventTargetProxy
	CYIEventTargetProxy (CYIEventTarget *pEventTarget)
const CYIEventTarget *	GetEventTarget () const
CYIEventTarget *	GetEventTarget ()

Member Function Documentation

GetSceneNode() [1/2]

const CYISceneNode* CYISceneNodeProxy::GetSceneNode

(

)

const

Returns the scene node that is proxied by this object. Scene nodes set this to nullptr on their associated proxy object when the scene node is deleted.

GetSceneNode() [2/2]

CYISceneNode* CYISceneNodeProxy::GetSceneNode

(

)

Hide()

void CYISceneNodeProxy::Hide

(

)

See also

CYISceneNode::Hide()

SetAnchorPoint() [1/2]

void CYISceneNodeProxy::SetAnchorPoint

(

const glm::vec3 &

ref

)

See also

CYISceneNode::SetAnchorPoint(const glm::vec3 &)

SetAnchorPoint() [2/2]

void CYISceneNodeProxy::SetAnchorPoint	(	float	x,
		float	y,
		float	z
	)

See also

CYISceneNode::SetAnchorPoint(float, float, float)

SetAnchorPointX()

void CYISceneNodeProxy::SetAnchorPointX

(

float

x

)

See also

CYISceneNode::SetAnchorPointX()

SetAnchorPointY()

void CYISceneNodeProxy::SetAnchorPointY

(

float

y

)

See also

CYISceneNode::SetAnchorPointY()

SetAnchorPointZ()

void CYISceneNodeProxy::SetAnchorPointZ

(

float

z

)

See also

CYISceneNode::SetAnchorPointZ()

SetInternalCustomTimelineValue()

void CYISceneNodeProxy::SetInternalCustomTimelineValue	(	uint32_t	trackID,
		const CYIVariant &	value
	)

See also

CYISceneNode::SetInternalCustomTimelineValue(uint32_t, const CYIVariant &)

SetOpacity()

void CYISceneNodeProxy::SetOpacity

(

float

opacity

)

See also

CYISceneNode::SetOpacity()

SetOrientation() [1/2]

void CYISceneNodeProxy::SetOrientation	(	float	pitchDegrees,
		float	yawDegrees,
		float	rollDegrees
	)

See also

CYISceneNode::SetOrientation(float, float, float)

SetOrientation() [2/2]

void CYISceneNodeProxy::SetOrientation

(

const glm::quat &

orient

)

See also

CYISceneNode::SetOrientation(const glm::quat &)

SetPosition() [1/2]

void CYISceneNodeProxy::SetPosition

(

const glm::vec3 &

ref

)

See also

CYISceneNode::SetPosition(const glm::vec3 &)

SetPosition() [2/2]

void CYISceneNodeProxy::SetPosition	(	float	x,
		float	y,
		float	z
	)

See also

CYISceneNode::SetPosition(float, float, float)

SetPositionX()

void CYISceneNodeProxy::SetPositionX

(

float

x

)

See also

CYISceneNode::SetPositionX()

SetPositionY()

void CYISceneNodeProxy::SetPositionY

(

float

y

)

See also

CYISceneNode::SetPositionY()

SetPositionZ()

void CYISceneNodeProxy::SetPositionZ

(

float

z

)

See also

CYISceneNode::SetPositionZ()

SetRotation() [1/2]

void CYISceneNodeProxy::SetRotation

(

const glm::vec3 &

eulerDegrees

)

See also

CYISceneNode::SetRotation(const glm::vec3 &)

SetRotation() [2/2]

void CYISceneNodeProxy::SetRotation	(	float	pitchDegrees,
		float	yawDegrees,
		float	rollDegrees
	)

See also

CYISceneNode::SetRotation(float, float, float)

SetRotationX()

void CYISceneNodeProxy::SetRotationX

(

float

pitchDegrees

)

See also

CYISceneNode::SetRotationX()

SetRotationY()

void CYISceneNodeProxy::SetRotationY

(

float

yawDegrees

)

See also

CYISceneNode::SetRotationY()

SetRotationZ()

void CYISceneNodeProxy::SetRotationZ

(

float

rollDegrees

)

See also

CYISceneNode::SetRotationZ()

SetScale() [1/2]

void CYISceneNodeProxy::SetScale

(

const glm::vec3 &

scaleFactors

)

See also

CYISceneNode::SetScale(const glm::vec3 &)

SetScale() [2/2]

void CYISceneNodeProxy::SetScale	(	float	factorX,
		float	factorY,
		float	factorZ
	)

See also

CYISceneNode::SetScale(float, float, float)

SetScaleX()

void CYISceneNodeProxy::SetScaleX

(

float

factor

)

See also

CYISceneNode::SetScaleX()

SetScaleY()

void CYISceneNodeProxy::SetScaleY

(

float

factor

)

See also

CYISceneNode::SetScaleY()

SetScaleZ()

void CYISceneNodeProxy::SetScaleZ

(

float

factor

)

See also

CYISceneNode::SetScaleZ()

Show()

void CYISceneNodeProxy::Show

(

)

See also

CYISceneNode::Show()

---

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

• scenetree/YiSceneNodeProxy.h