torque Torque Game Engine Documentation
TGE Version 1.5.2

EditTSCtrl Class Reference

#include <editTSCtrl.h>

Inheritance diagram for EditTSCtrl:

Inheritance graph
[legend]

Public Member Functions

 EditTSCtrl ()
 ~EditTSCtrl ()
bool onAdd ()
 Called when this object is added to the scene.
bool processCameraQuery (CameraQuery *query)
virtual void onRender (Point2I offset, const RectI &updateRect)
 Called when this control is to render itself.
virtual void on3DMouseUp (const Gui3DMouseEvent &)
virtual void on3DMouseDown (const Gui3DMouseEvent &)
virtual void on3DMouseMove (const Gui3DMouseEvent &)
virtual void on3DMouseDragged (const Gui3DMouseEvent &)
virtual void on3DMouseEnter (const Gui3DMouseEvent &)
virtual void on3DMouseLeave (const Gui3DMouseEvent &)
virtual void on3DRightMouseDown (const Gui3DMouseEvent &)
virtual void on3DRightMouseUp (const Gui3DMouseEvent &)
virtual void on3DRightMouseDragged (const Gui3DMouseEvent &)
virtual void get3DCursor (GuiCursor *&cursor, bool &visible, const Gui3DMouseEvent &)
 DECLARE_CONOBJECT (EditTSCtrl)

Static Public Member Functions

static void initPersistFields ()
 Register dynamic fields in a subclass of ConsoleObject.
static void consoleInit ()
 Register global constant variables and do other one-time initialization tasks in a subclass of ConsoleObject.

Data Fields

bool mRenderMissionArea
ColorI mMissionAreaFillColor
ColorI mMissionAreaFrameColor
ColorI mConsoleFrameColor
ColorI mConsoleFillColor
S32 mConsoleSphereLevel
S32 mConsoleCircleSegments
S32 mConsoleLineWidth
bool mConsoleRendering
bool mRightMousePassThru

Static Public Attributes

static Point3F smCamPos
static EulerF smCamRot
static MatrixF smCamMatrix
static F32 smVisibleDistance

Protected Member Functions

void make3DMouseEvent (Gui3DMouseEvent &gui3Devent, const GuiEvent &event)
void getCursor (GuiCursor *&cursor, bool &showCursor, const GuiEvent &lastGuiEvent)
 Get information about the cursor.
void onMouseUp (const GuiEvent &event)
void onMouseDown (const GuiEvent &event)
void onMouseMove (const GuiEvent &event)
void onMouseDragged (const GuiEvent &event)
void onMouseEnter (const GuiEvent &event)
void onMouseLeave (const GuiEvent &event)
void onRightMouseDown (const GuiEvent &event)
void onRightMouseUp (const GuiEvent &event)
void onRightMouseDragged (const GuiEvent &event)
bool onInputEvent (const InputEvent &event)
 General input handler.
virtual void updateGuiInfo ()
virtual void renderScene (const RectI &)
void renderMissionArea ()
void renderWorld (const RectI &updateRect)

Protected Attributes

EditManagermEditManager
Gui3DMouseEvent mLastEvent

Private Types

typedef GuiTSCtrl Parent

Member Typedef Documentation

typedef GuiTSCtrl EditTSCtrl::Parent [private]

Reimplemented from GuiTSCtrl.

Reimplemented in TerrainEditor, and WorldEditor.


Constructor & Destructor Documentation

EditTSCtrl::EditTSCtrl (  ) 

EditTSCtrl::~EditTSCtrl (  ) 


Member Function Documentation

void EditTSCtrl::make3DMouseEvent ( Gui3DMouseEvent gui3Devent,
const GuiEvent event 
) [protected]

void EditTSCtrl::getCursor ( GuiCursor *&  cursor,
bool &  showCursor,
const GuiEvent lastGuiEvent 
) [protected, 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.

Reimplemented in TerrainEditor.

void EditTSCtrl::onMouseUp ( const GuiEvent event  )  [protected, virtual]

Reimplemented from GuiControl.

void EditTSCtrl::onMouseDown ( const GuiEvent event  )  [protected, virtual]

Reimplemented from GuiControl.

void EditTSCtrl::onMouseMove ( const GuiEvent event  )  [protected, virtual]

Reimplemented from GuiControl.

void EditTSCtrl::onMouseDragged ( const GuiEvent event  )  [protected, virtual]

Reimplemented from GuiControl.

void EditTSCtrl::onMouseEnter ( const GuiEvent event  )  [protected, virtual]

Reimplemented from GuiControl.

void EditTSCtrl::onMouseLeave ( const GuiEvent event  )  [protected, virtual]

Reimplemented from GuiControl.

void EditTSCtrl::onRightMouseDown ( const GuiEvent event  )  [protected, virtual]

Reimplemented from GuiControl.

void EditTSCtrl::onRightMouseUp ( const GuiEvent event  )  [protected, virtual]

Reimplemented from GuiControl.

void EditTSCtrl::onRightMouseDragged ( const GuiEvent event  )  [protected, virtual]

Reimplemented from GuiControl.

bool EditTSCtrl::onInputEvent ( const InputEvent event  )  [protected, virtual]

General input handler.

Reimplemented from GuiControl.

virtual void EditTSCtrl::updateGuiInfo (  )  [inline, protected, virtual]

Reimplemented in TerrainEditor, and WorldEditor.

virtual void EditTSCtrl::renderScene ( const RectI  )  [inline, protected, virtual]

Reimplemented in TerrainEditor, and WorldEditor.

void EditTSCtrl::renderMissionArea (  )  [protected]

void EditTSCtrl::renderWorld ( const RectI updateRect  )  [protected, virtual]

Reimplemented from GuiTSCtrl.

bool EditTSCtrl::onAdd (  )  [virtual]

Called when this object is added to the scene.

Reimplemented from GuiControl.

Reimplemented in TerrainEditor, and WorldEditor.

static void EditTSCtrl::initPersistFields (  )  [static]

Register dynamic fields in a subclass of ConsoleObject.

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

Reimplemented from GuiTSCtrl.

Reimplemented in TerrainEditor, and WorldEditor.

static void EditTSCtrl::consoleInit (  )  [static]

Register global constant variables and do other one-time initialization tasks in a subclass of ConsoleObject.

Deprecated:
You should use ConsoleMethod and ConsoleFunction, not this, to register methods or commands.
See also:
console

Reimplemented from GuiTSCtrl.

bool EditTSCtrl::processCameraQuery ( CameraQuery query  )  [virtual]

Reimplemented from GuiTSCtrl.

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

virtual void EditTSCtrl::on3DMouseUp ( const Gui3DMouseEvent  )  [inline, virtual]

Reimplemented in TerrainEditor, and WorldEditor.

virtual void EditTSCtrl::on3DMouseDown ( const Gui3DMouseEvent  )  [inline, virtual]

Reimplemented in TerrainEditor, and WorldEditor.

virtual void EditTSCtrl::on3DMouseMove ( const Gui3DMouseEvent  )  [inline, virtual]

Reimplemented in TerrainEditor, and WorldEditor.

virtual void EditTSCtrl::on3DMouseDragged ( const Gui3DMouseEvent  )  [inline, virtual]

Reimplemented in TerrainEditor, and WorldEditor.

virtual void EditTSCtrl::on3DMouseEnter ( const Gui3DMouseEvent  )  [inline, virtual]

Reimplemented in WorldEditor.

virtual void EditTSCtrl::on3DMouseLeave ( const Gui3DMouseEvent  )  [inline, virtual]

Reimplemented in WorldEditor.

virtual void EditTSCtrl::on3DRightMouseDown ( const Gui3DMouseEvent  )  [inline, virtual]

Reimplemented in WorldEditor.

virtual void EditTSCtrl::on3DRightMouseUp ( const Gui3DMouseEvent  )  [inline, virtual]

Reimplemented in WorldEditor.

virtual void EditTSCtrl::on3DRightMouseDragged ( const Gui3DMouseEvent  )  [inline, virtual]

virtual void EditTSCtrl::get3DCursor ( GuiCursor *&  cursor,
bool &  visible,
const Gui3DMouseEvent  
) [virtual]

Reimplemented in WorldEditor.

EditTSCtrl::DECLARE_CONOBJECT ( EditTSCtrl   ) 


Field Documentation




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