EditTSCtrl Class Reference

#include <editTSCtrl.h>

Inheritance diagram for EditTSCtrl:

Inheritance graph
[legend]
List of all members.

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 on3DMouseWheelUp (const Gui3DMouseEvent &)
virtual void on3DMouseWheelDown (const Gui3DMouseEvent &)
virtual void get3DCursor (GuiCursor *&cursor, bool &visible, const Gui3DMouseEvent &)
virtual S32 getDisplayType ()
virtual void setDisplayType (S32 type)
virtual TerrainBlock * getActiveTerrain ()
virtual void calcOrthoCamOffset (F32 mousex, F32 mousey, U8 modifier=0)
 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.

Public Attributes

bool mRenderMissionArea
ColorI mMissionAreaFillColor
ColorI mMissionAreaFrameColor
ColorI mConsoleFrameColor
ColorI mConsoleFillColor
S32 mConsoleSphereLevel
S32 mConsoleCircleSegments
S32 mConsoleLineWidth
bool mConsoleRendering
bool mRightMousePassThru
bool mRenderGridPlane
ColorI mGridPlaneColor
F32 mGridPlaneSize
F32 mGridPlaneSizePixelBias
S32 mGridPlaneMinorTicks
ColorI mGridPlaneMinorTickColor
ColorI mGridPlaneOriginColor
GFXStateBlockRef mBlendSB

Static Public Attributes

static Point3F smCamPos
static MatrixF smCamMatrix
static bool smCamOrtho
static F32 smCamNearPlane
static F32 smVisibleDistance
static U32 smSceneBoundsMask
static Point3F smMinSceneBounds

Protected Types

 DisplayTypeTop
 DisplayTypeBottom
 DisplayTypeFront
 DisplayTypeBack
 DisplayTypeLeft
 DisplayTypeRight
 DisplayTypePerspective
 DisplayTypeIsometric
enum  DisplayType {
  DisplayTypeTop,
  DisplayTypeBottom,
  DisplayTypeFront,
  DisplayTypeBack,
  DisplayTypeLeft,
  DisplayTypeRight,
  DisplayTypePerspective,
  DisplayTypeIsometric
}

Protected Attributes

S32 mDisplayType
F32 mOrthoFOV
Point3F mOrthoCamTrans
EulerF mIsoCamRot
Point3F mIsoCamRotCenter
F32 mIsoCamAngle
Point3F mRawCamPos
Point2I mLastMousePos
bool mLastMouseClamping
bool mAllowBorderMove
S32 mMouseMoveBorder
F32 mMouseMoveSpeed
U32 mLastBorderMoveTime
Gui3DMouseEvent mLastEvent
bool mLeftMouseDown
bool mRightMouseDown
bool mMouseLeft

Private Types

typedef GuiTSCtrl Parent

Private Member Functions

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

Member Typedef Documentation

typedef GuiTSCtrl EditTSCtrl::Parent [private]

Reimplemented from GuiTSCtrl.

Reimplemented in TerrainEditor, and WorldEditor.

Member Enumeration Documentation

enum EditTSCtrl::DisplayType [protected]

Enumerator:
DisplayTypeTop 
DisplayTypeBottom 
DisplayTypeFront 
DisplayTypeBack 
DisplayTypeLeft 
DisplayTypeRight 
DisplayTypePerspective 
DisplayTypeIsometric 

Constructor & Destructor Documentation

EditTSCtrl::EditTSCtrl (  ) 

EditTSCtrl::~EditTSCtrl (  ) 

Member Function Documentation

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

virtual void EditTSCtrl::getCursor ( GuiCursor *&  cursor,
bool &  showCursor,
const GuiEvent &  lastGuiEvent 
) [private, 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 modifier keys (ie ctrl, shift, alt etc)

Reimplemented from GuiControl.

Reimplemented in TerrainEditor.

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

Reimplemented from GuiControl.

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

Reimplemented from GuiControl.

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

Reimplemented from GuiControl.

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

Reimplemented from GuiControl.

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

Reimplemented from GuiControl.

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

Reimplemented from GuiControl.

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

Reimplemented from GuiControl.

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

Reimplemented from GuiControl.

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

Reimplemented from GuiControl.

virtual bool EditTSCtrl::onInputEvent ( const InputEventInfo &  event  )  [private, virtual]

General input handler.

Reimplemented from GuiControl.

virtual bool EditTSCtrl::onMouseWheelUp ( const GuiEvent &  event  )  [private, virtual]

Reimplemented from GuiControl.

virtual bool EditTSCtrl::onMouseWheelDown ( const GuiEvent &  event  )  [private, virtual]

Reimplemented from GuiControl.

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

Reimplemented in TerrainEditor, and WorldEditor.

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

Reimplemented in TerrainEditor, and WorldEditor.

void EditTSCtrl::renderMissionArea (  )  [private]

virtual void EditTSCtrl::renderCameraAxis (  )  [private, virtual]

virtual void EditTSCtrl::renderGrid (  )  [private, virtual]

void EditTSCtrl::renderWorld ( const RectI &  updateRect  )  [private, 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(), addDeprecatedField(), 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.

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::on3DMouseWheelUp ( const Gui3DMouseEvent &   )  [inline, virtual]

Reimplemented in TerrainEditor.

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

Reimplemented in TerrainEditor.

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

Reimplemented in WorldEditor.

virtual S32 EditTSCtrl::getDisplayType (  )  [inline, virtual]

virtual void EditTSCtrl::setDisplayType ( S32  type  )  [inline, virtual]

virtual TerrainBlock* EditTSCtrl::getActiveTerrain (  )  [virtual]

Reimplemented in TerrainEditor.

virtual void EditTSCtrl::calcOrthoCamOffset ( F32  mousex,
F32  mousey,
U8  modifier = 0 
) [virtual]

EditTSCtrl::DECLARE_CONOBJECT ( EditTSCtrl   ) 

Member Data Documentation

S32 EditTSCtrl::mDisplayType [protected]

F32 EditTSCtrl::mOrthoFOV [protected]

Point3F EditTSCtrl::mOrthoCamTrans [protected]

EulerF EditTSCtrl::mIsoCamRot [protected]

Point3F EditTSCtrl::mIsoCamRotCenter [protected]

F32 EditTSCtrl::mIsoCamAngle [protected]

Point3F EditTSCtrl::mRawCamPos [protected]

Point2I EditTSCtrl::mLastMousePos [protected]

bool EditTSCtrl::mLastMouseClamping [protected]

bool EditTSCtrl::mAllowBorderMove [protected]

S32 EditTSCtrl::mMouseMoveBorder [protected]

F32 EditTSCtrl::mMouseMoveSpeed [protected]

U32 EditTSCtrl::mLastBorderMoveTime [protected]

Gui3DMouseEvent EditTSCtrl::mLastEvent [protected]

bool EditTSCtrl::mLeftMouseDown [protected]

bool EditTSCtrl::mRightMouseDown [protected]

bool EditTSCtrl::mMouseLeft [protected]

bool EditTSCtrl::mRenderMissionArea

ColorI EditTSCtrl::mMissionAreaFillColor

ColorI EditTSCtrl::mMissionAreaFrameColor

ColorI EditTSCtrl::mConsoleFrameColor

ColorI EditTSCtrl::mConsoleFillColor

S32 EditTSCtrl::mConsoleSphereLevel

S32 EditTSCtrl::mConsoleCircleSegments

S32 EditTSCtrl::mConsoleLineWidth

bool EditTSCtrl::mConsoleRendering

bool EditTSCtrl::mRightMousePassThru

Point3F EditTSCtrl::smCamPos [static]

MatrixF EditTSCtrl::smCamMatrix [static]

bool EditTSCtrl::smCamOrtho [static]

F32 EditTSCtrl::smCamNearPlane [static]

F32 EditTSCtrl::smVisibleDistance [static]

U32 EditTSCtrl::smSceneBoundsMask [static]

Point3F EditTSCtrl::smMinSceneBounds [static]

bool EditTSCtrl::mRenderGridPlane

ColorI EditTSCtrl::mGridPlaneColor

F32 EditTSCtrl::mGridPlaneSize

F32 EditTSCtrl::mGridPlaneSizePixelBias

S32 EditTSCtrl::mGridPlaneMinorTicks

ColorI EditTSCtrl::mGridPlaneMinorTickColor

ColorI EditTSCtrl::mGridPlaneOriginColor

GFXStateBlockRef EditTSCtrl::mBlendSB

© GarageGames.com Home Back to Top
© GarageGames.com Home Back to Top