GuiObjectView Class Reference

#include <guiObjectView.h>

Inheritance diagram for GuiObjectView:

Inheritance graph

[legend]List of all members.


Public Member Functions
bool	onWake ()
	Called when this object is asked to wake up returns true if it's actually awake at the end.
void	onMouseEnter (const GuiEvent &event)
void	onMouseLeave (const GuiEvent &event)
void	onMouseDown (const GuiEvent &event)
void	onMouseUp (const GuiEvent &event)
void	onMouseDragged (const GuiEvent &event)
void	onRightMouseDown (const GuiEvent &event)
void	onRightMouseUp (const GuiEvent &event)
void	onRightMouseDragged (const GuiEvent &event)
void	setObjectModel (const char *modelName)
void	setObjectAnimation (S32 index)
void	setMountedObject (const char *modelName, S32 mountPoint)
void	getMountedObjTransform (MatrixF *mat)
void	setOrbitDistance (F32 distance)
	Sets the distance at which the camera orbits the object.
bool	processCameraQuery (CameraQuery *query)
void	renderWorld (const RectI &updateRect)
	DECLARE_CONOBJECT (GuiObjectView)
	GuiObjectView ()
	~GuiObjectView ()
Protected Types
	None
	Rotating
	Zooming
enum	MouseState { None, Rotating, Zooming }
Protected Attributes
MouseState	mMouseState
TSShapeInstance *	mModel
TSShapeInstance *	mMountedModel
U32	mSkinTag
Point3F	mCameraPos
MatrixF	mCameraMatrix
EulerF	mCameraRot
Point3F	mOrbitPos
S32	mMountNode
TSThread *	runThread
S32	lastRenderTime
S32	mAnimationSeq
Point2I	mLastMousePoint
LightInfo *	mFakeSun
Private Types
typedef GuiTSCtrl	Parent
Private Attributes
F32	mMaxOrbitDist
F32	mMinOrbitDist
F32	mOrbitDist
Static Private Attributes
static const S32	MAX_ANIMATIONS = 6
	Maximum number of animations for the primary model displayed in this control.
static const S32	NO_NODE = -1
	Indicates there is no node with a mounted object.

Member Typedef Documentation

typedef GuiTSCtrl GuiObjectView::Parent [private]

Reimplemented from GuiTSCtrl.

Member Enumeration Documentation

enum GuiObjectView::MouseState [protected]

Enumerator:

None
Rotating
Zooming

Constructor & Destructor Documentation

GuiObjectView::GuiObjectView ( )

GuiObjectView::~GuiObjectView ( )

Member Function Documentation

bool GuiObjectView::onWake ( ) [virtual]

Called when this object is asked to wake up returns true if it's actually awake at the end.

Reimplemented from GuiControl.

void GuiObjectView::onMouseEnter ( const GuiEvent & event ) [virtual]

Reimplemented from GuiControl.

void GuiObjectView::onMouseLeave ( const GuiEvent & event ) [virtual]

Reimplemented from GuiControl.

void GuiObjectView::onMouseDown ( const GuiEvent & event ) [virtual]

Reimplemented from GuiControl.

void GuiObjectView::onMouseUp ( const GuiEvent & event ) [virtual]

Reimplemented from GuiControl.

void GuiObjectView::onMouseDragged ( const GuiEvent & event ) [virtual]

Reimplemented from GuiControl.

void GuiObjectView::onRightMouseDown ( const GuiEvent & event ) [virtual]

Reimplemented from GuiControl.

void GuiObjectView::onRightMouseUp ( const GuiEvent & event ) [virtual]

Reimplemented from GuiControl.

void GuiObjectView::onRightMouseDragged ( const GuiEvent & event ) [virtual]

Reimplemented from GuiControl.

void GuiObjectView::setObjectModel ( const char * modelName )

void GuiObjectView::setObjectAnimation ( S32 index )

void GuiObjectView::setMountedObject	(	const char *	modelName,
		S32	mountPoint
	)

void GuiObjectView::getMountedObjTransform ( MatrixF * mat )

void GuiObjectView::setOrbitDistance ( F32 distance )

Sets the distance at which the camera orbits the object.

Clamped to the acceptable range defined in the class by min and max orbit distances.

Parameters:

distance

The distance to set the orbit to (will be clamped).

bool GuiObjectView::processCameraQuery ( CameraQuery * query ) [virtual]

Reimplemented from GuiTSCtrl.

void GuiObjectView::renderWorld ( const RectI & updateRect ) [virtual]

Reimplemented from GuiTSCtrl.

GuiObjectView::DECLARE_CONOBJECT ( GuiObjectView )

Member Data Documentation

MouseState GuiObjectView::mMouseState [protected]

TSShapeInstance* GuiObjectView::mModel [protected]

TSShapeInstance* GuiObjectView::mMountedModel [protected]

U32 GuiObjectView::mSkinTag [protected]

Point3F GuiObjectView::mCameraPos [protected]

MatrixF GuiObjectView::mCameraMatrix [protected]

EulerF GuiObjectView::mCameraRot [protected]

Point3F GuiObjectView::mOrbitPos [protected]

S32 GuiObjectView::mMountNode [protected]

TSThread* GuiObjectView::runThread [protected]

S32 GuiObjectView::lastRenderTime [protected]

S32 GuiObjectView::mAnimationSeq [protected]

Point2I GuiObjectView::mLastMousePoint [protected]

LightInfo* GuiObjectView::mFakeSun [protected]

F32 GuiObjectView::mMaxOrbitDist [private]

F32 GuiObjectView::mMinOrbitDist [private]

F32 GuiObjectView::mOrbitDist [private]

const S32 GuiObjectView::MAX_ANIMATIONS = 6 [static, private]

Maximum number of animations for the primary model displayed in this control.

const S32 GuiObjectView::NO_NODE = -1 [static, private]

Indicates there is no node with a mounted object.