torque

Torque Game Engine Documentation
TGE Version 1.5.2

GuiInspectorGroup Class Reference

#include <guiInspector.h>

Inheritance diagram for GuiInspectorGroup:

Inheritance graph


Public Member Functions
	GuiInspectorGroup ()
	GuiInspectorGroup (SimObjectPtr< SimObject > target, StringTableEntry groupName, SimObjectPtr< GuiInspector > parent)
	~GuiInspectorGroup ()
	DECLARE_CONOBJECT (GuiInspectorGroup)
virtual void	onMouseDown (const GuiEvent &event)
virtual S32	getExpandedHeight ()
void	resize (const Point2I &newPosition, const Point2I &newExtent)
	Changes the size and/or position of this control.
void	animateTo (S32 height)
virtual void	processTick ()
	This method is called once every 32ms if isProcessingTicks returns true when called on the object.
virtual GuiInspectorField *	constructField (S32 fieldType)
virtual GuiInspectorField *	findField (StringTableEntry fieldName)
virtual void	onRender (Point2I offset, const RectI &updateRect)
	Called when this control is to render itself.
StringTableEntry	getGroupName ()
SimObjectPtr< SimObject >	getGroupTarget ()
SimObjectPtr< GuiInspector >	getContentCtrl ()
bool	onAdd ()
	Called when this object is added to the scene.
virtual bool	inspectGroup ()
Static Public Member Functions
static void	initPersistFields ()
	Register dynamic fields in a subclass of ConsoleObject.
Data Fields
StringTableEntry	mCaption
Point2I	mBarWidth
bool	mIsExpanded
bool	mIsAnimating
bool	mCollapsing
S32	mAnimateDestHeight
S32	mAnimateStep
S32	mChildHeight
SimObjectPtr< SimObject >	mTarget
SimObjectPtr< GuiInspector >	mParent
Vector< GuiInspectorField * >	mChildren
GuiStackControl *	mStack
Private Types
typedef GuiControl	Parent

Member Typedef Documentation

typedef GuiControl GuiInspectorGroup::Parent [private]

Reimplemented from GuiTickCtrl.

Reimplemented in GuiInspectorDynamicGroup.

Constructor & Destructor Documentation

GuiInspectorGroup::GuiInspectorGroup ( )

GuiInspectorGroup::GuiInspectorGroup	(	SimObjectPtr< SimObject >	target,
		StringTableEntry	groupName,
		SimObjectPtr< GuiInspector >	parent
	)

GuiInspectorGroup::~GuiInspectorGroup ( )

Member Function Documentation

GuiInspectorGroup::DECLARE_CONOBJECT ( GuiInspectorGroup )

static void GuiInspectorGroup::initPersistFields ( ) [static]

Register dynamic fields in a subclass of ConsoleObject.

See also:: addField(), addFieldV(), addDepricatedField(), addGroup(), endGroup()

Reimplemented from GuiControl.

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

Reimplemented from GuiControl.

Reimplemented in GuiInspectorDynamicGroup.

virtual S32 GuiInspectorGroup::getExpandedHeight ( ) [virtual]

Reimplemented in GuiInspectorDynamicGroup.

void GuiInspectorGroup::resize	(	const Point2I &	newPosition,
		const Point2I &	newExtent
	)			`[virtual]`

Changes the size and/or position of this control.

Parameters:

	newPosition	New position of this control
	newExtent	New size of this control

Reimplemented from GuiControl.

void GuiInspectorGroup::animateTo ( S32 height )

virtual void GuiInspectorGroup::processTick ( ) [virtual]

This method is called once every 32ms if isProcessingTicks returns true when called on the object.

Reimplemented from GuiTickCtrl.

virtual GuiInspectorField* GuiInspectorGroup::constructField ( S32 fieldType ) [virtual]

virtual GuiInspectorField* GuiInspectorGroup::findField ( StringTableEntry fieldName ) [virtual]

virtual void GuiInspectorGroup::onRender	(	Point2I	offset,
		const RectI &	updateRect
	)			`[virtual]`

Called when this control is to render itself.

Parameters:

	offset	The location this control is to begin rendering
	updateRect	The screen area this control has drawing access to

Reimplemented from GuiControl.

Reimplemented in GuiInspectorDynamicGroup.

StringTableEntry GuiInspectorGroup::getGroupName ( ) [inline]

SimObjectPtr<SimObject> GuiInspectorGroup::getGroupTarget ( ) [inline]

SimObjectPtr<GuiInspector> GuiInspectorGroup::getContentCtrl ( ) [inline]

bool GuiInspectorGroup::onAdd ( ) [virtual]

Called when this object is added to the scene.

Reimplemented from GuiControl.

virtual bool GuiInspectorGroup::inspectGroup ( ) [virtual]

Reimplemented in GuiInspectorDynamicGroup.

Field Documentation

StringTableEntry GuiInspectorGroup::mCaption

Point2I GuiInspectorGroup::mBarWidth

bool GuiInspectorGroup::mIsExpanded

bool GuiInspectorGroup::mIsAnimating

bool GuiInspectorGroup::mCollapsing

S32 GuiInspectorGroup::mAnimateDestHeight

S32 GuiInspectorGroup::mAnimateStep

S32 GuiInspectorGroup::mChildHeight

SimObjectPtr<SimObject> GuiInspectorGroup::mTarget

SimObjectPtr<GuiInspector> GuiInspectorGroup::mParent

Vector<GuiInspectorField*> GuiInspectorGroup::mChildren

GuiStackControl* GuiInspectorGroup::mStack

All Rights Reserved GarageGames.com, Inc. 1999-2005
Auto-magically Generated with Doxygen