Torque Game Engine Documentation
TGE Version 1.5.2

GuiFrameSetCtrl Class Reference

#include <guiFrameCtrl.h>

Inheritance diagram for GuiFrameSetCtrl:


Public Types
enum	{ FRAME_STATE_ON, FRAME_STATE_OFF, FRAME_STATE_AUTO, NO_HIT = -1, DEFAULT_BORDER_WIDTH = 4, DEFAULT_COLUMNS = 1, DEFAULT_ROWS = 1, DEFAULT_MIN_FRAME_EXTENT = 64 }
enum	Region { VERTICAL_DIVIDER, HORIZONTAL_DIVIDER, DIVIDER_INTERSECTION, NONE }
Public Member Functions
	DECLARE_CONOBJECT (GuiFrameSetCtrl)
	GuiFrameSetCtrl ()
	GuiFrameSetCtrl (U32 columns, U32 rows, const U32 columnOffsets[]=NULL, const U32 rowOffsets[]=NULL)
virtual	~GuiFrameSetCtrl ()
void	addObject (SimObject *obj)
	Adds an object as a child of this object.
void	removeObject (SimObject *obj)
	Removes a child object from this control.
virtual void	resize (const Point2I &newPosition, const Point2I &newExtent)
	Changes the size and/or position of this control.
virtual void	getCursor (GuiCursor *&cursor, bool &showCursor, const GuiEvent &lastGuiEvent)
	Get information about the cursor.
virtual void	onMouseDown (const GuiEvent &event)
virtual void	onMouseUp (const GuiEvent &event)
virtual void	onMouseDragged (const GuiEvent &event)
virtual void	onMouseEnter (const GuiEvent &event)
virtual void	onMouseLeave (const GuiEvent &event)
bool	onAdd ()
	Called when this object is added to the scene.
void	onRender (Point2I offset, const RectI &updateRect)
	Called when this control is to render itself.
U32	columns () const
U32	rows () const
U32	borderWidth () const
Vector< S32 > *	columnOffsets ()
Vector< S32 > *	rowOffsets ()
FrameDetail *	framesetDetails ()
bool	findFrameContents (S32 index, GuiControl gc, FrameDetail fd)
void	frameBorderEnable (S32 index, const char *state=NULL)
void	frameBorderMovable (S32 index, const char *state=NULL)
void	frameMinExtent (S32 index, const Point2I &extent)
void	balanceFrames ()
void	updateSizes ()
bool	onWake ()
	Called when this object is asked to wake up returns true if it's actually awake at the end.
Static Public Member Functions
static void	initPersistFields ()
	Register dynamic fields in a subclass of ConsoleObject.
Protected Member Functions
bool	init (U32 columns, U32 rows, const U32 columnOffsets[], const U32 rowOffsets[])
bool	initCursors ()
Region	findHitRegion (const Point2I &point)
Region	pointInAnyRegion (const Point2I &point)
S32	findResizableFrames (S32 indexes[])
bool	hitVerticalDivider (S32 x, const Point2I &point)
bool	hitHorizontalDivider (S32 y, const Point2I &point)
void	rebalance (const Point2I &newExtent)
void	computeSizes (bool balanceFrames=false)
void	computeMovableRange (Region hitRegion, S32 vertHit, S32 horzHit, S32 numIndexes, const S32 indexes[], S32 ranges[])
void	drawDividers (const Point2I &offset)
Protected Attributes
Vector< S32 >	mColumnOffsets
Vector< S32 >	mRowOffsets
GuiCursor *	mMoveCursor
GuiCursor *	mUpDownCursor
GuiCursor *	mLeftRightCursor
GuiCursor *	mDefaultCursor
FrameDetail	mFramesetDetails
VectorPtr< FrameDetail * >	mFrameDetails
bool	mAutoBalance
S32	mFudgeFactor
Region	mCurHitRegion
Point2I	mLocOnDivider
S32	mCurVerticalHit
S32	mCurHorizontalHit
Private Types
typedef GuiControl	Parent
Private Member Functions
	DISABLE_COPY_CTOR (GuiFrameSetCtrl)
	DISABLE_ASSIGNMENT (GuiFrameSetCtrl)
Data Structures
struct	FrameDetail

Member Typedef Documentation

typedef GuiControl GuiFrameSetCtrl::Parent [private]

Reimplemented from GuiControl.

Member Enumeration Documentation

anonymous enum

Enumerator:

FRAME_STATE_ON
FRAME_STATE_OFF
FRAME_STATE_AUTO
NO_HIT
DEFAULT_BORDER_WIDTH
DEFAULT_COLUMNS
DEFAULT_ROWS
DEFAULT_MIN_FRAME_EXTENT

enum GuiFrameSetCtrl::Region

Enumerator:

VERTICAL_DIVIDER
HORIZONTAL_DIVIDER
DIVIDER_INTERSECTION
NONE

Constructor & Destructor Documentation

GuiFrameSetCtrl::GuiFrameSetCtrl ( )

GuiFrameSetCtrl::GuiFrameSetCtrl	(	U32	columns,
		U32	rows,
		const U32	columnOffsets[] = `NULL`,
		const U32	rowOffsets[] = `NULL`
	)

virtual GuiFrameSetCtrl::~GuiFrameSetCtrl ( ) [virtual]

Member Function Documentation

GuiFrameSetCtrl::DECLARE_CONOBJECT ( GuiFrameSetCtrl )

static void GuiFrameSetCtrl::initPersistFields ( ) [static]

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

Reimplemented from GuiControl.

void GuiFrameSetCtrl::addObject ( SimObject * obj ) [virtual]

Adds an object as a child of this object.

Parameters:

obj

New child object of this control

Reimplemented from GuiControl.

void GuiFrameSetCtrl::removeObject ( SimObject * obj ) [virtual]

Removes a child object from this control.

Parameters:

obj

Object to remove from this control

Reimplemented from GuiControl.

virtual void GuiFrameSetCtrl::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.

virtual void GuiFrameSetCtrl::getCursor	(	GuiCursor *&	cursor,
		bool &	showCursor,
		const GuiEvent &	lastGuiEvent
	)			`[virtual]`

Get information about the cursor.

Parameters:

	cursor	Cursor information will be stored here
	showCursor	Will be set to true if the cursor is visible
	lastGuiEvent	GuiEvent containing cursor position and modifyer keys (ie ctrl, shift, alt etc)

Reimplemented from GuiControl.

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

Reimplemented from GuiControl.

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

Reimplemented from GuiControl.

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

Reimplemented from GuiControl.

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

Reimplemented from GuiControl.

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

Reimplemented from GuiControl.

bool GuiFrameSetCtrl::onAdd ( ) [virtual]

Called when this object is added to the scene.

Reimplemented from GuiControl.

void GuiFrameSetCtrl::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.

bool GuiFrameSetCtrl::init	(	U32	columns,
		U32	rows,
		const U32	columnOffsets[],
		const U32	rowOffsets[]
	)			`[protected]`

bool GuiFrameSetCtrl::initCursors ( ) [protected]

Region GuiFrameSetCtrl::findHitRegion ( const Point2I & point ) [protected]

Region GuiFrameSetCtrl::pointInAnyRegion ( const Point2I & point ) [protected]

S32 GuiFrameSetCtrl::findResizableFrames ( S32 indexes[] ) [protected]

bool GuiFrameSetCtrl::hitVerticalDivider	(	S32	x,
		const Point2I &	point
	)			`[inline, protected]`

bool GuiFrameSetCtrl::hitHorizontalDivider	(	S32	y,
		const Point2I &	point
	)			`[inline, protected]`

void GuiFrameSetCtrl::rebalance ( const Point2I & newExtent ) [protected]

void GuiFrameSetCtrl::computeSizes ( bool balanceFrames = false ) [protected]

void GuiFrameSetCtrl::computeMovableRange	(	Region	hitRegion,
		S32	vertHit,
		S32	horzHit,
		S32	numIndexes,
		const S32	indexes[],
		S32	ranges[]
	)			`[protected]`