torque Torque Game Engine Documentation
TGE Version 1.5.2

MissionAreaEditor Class Reference

#include <missionAreaEditor.h>

Inheritance diagram for MissionAreaEditor:

Inheritance graph
[legend]

Public Member Functions

 MissionAreaEditor ()
bool missionAreaObjValid ()
bool terrainObjValid ()
TerrainBlockgetTerrainObj ()
const RectIgetArea ()
void setArea (const RectI &area)
void updateTerrainBitmap ()
void parentResized (const Point2I &oldParentExtent, const Point2I &newParentExtent)
 Called when this objects parent is resized.
void onRender (Point2I offset, const RectI &updateRect)
 Called when this control is to render itself.
bool onWake ()
 Called when this object is asked to wake up returns true if it's actually awake at the end.
void onSleep ()
 Called when this object is asked to sleep.
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)
bool onAdd ()
 Called when this object is added to the scene.
 DECLARE_CONOBJECT (MissionAreaEditor)

Static Public Member Functions

static void initPersistFields ()
 Register dynamic fields in a subclass of ConsoleObject.

Data Fields

bool mSquareBitmap
bool mEnableEditing
bool mRenderCamera
ColorI mHandleFrameColor
ColorI mHandleFillColor
ColorI mDefaultObjectColor
ColorI mWaterObjectColor
ColorI mMissionBoundsColor
ColorI mCameraColor
bool mEnableMirroring
S32 mMirrorIndex
ColorI mMirrorLineColor
ColorI mMirrorArrowColor

Private Types

enum  {
  DefaultCursor = 0,
  HandCursor,
  GrabCursor,
  VertResizeCursor,
  HorizResizeCursor,
  DiagRightResizeCursor,
  DiagLeftResizeCursor,
  NumCursors
}
enum  { NUT_SIZE = 3 }
enum  {
  nothing = 0,
  sizingLeft = BIT(0),
  sizingRight = BIT(1),
  sizingTop = BIT(2),
  sizingBottom = BIT(3),
  moving = BIT(4)
}
typedef GuiBitmapCtrl Parent

Private Member Functions

GBitmapcreateTerrainBitmap ()
void onUpdate ()
void setControlObjPos (const Point2F &pos)
bool clampArea (RectI &area)
Point2F worldToScreen (const Point2F &)
Point2F screenToWorld (const Point2F &)
void getScreenMissionArea (RectI &rect)
void getScreenMissionArea (RectF &rect)
void setupScreenTransform (const Point2I &offset)
bool grabCursors ()
void getCursor (GuiCursor *&cursor, bool &showCursor, const GuiEvent &lastGuiEvent)
 Get information about the cursor.
void setCursor (U32 cursor)
void updateCursor (S32 hit)
bool inNut (const Point2I &pt, S32 x, S32 y)
S32 getSizingHitKnobs (const Point2I &pt, const RectI &box)
void drawNut (const Point2I &nut)
void drawNuts (RectI &box)

Private Attributes

SimObjectPtr< MissionAreamMissionArea
SimObjectPtr< TerrainBlockmTerrainBlock
VectorF mScale
Point2F mCenterPos
GuiCursormCurrentCursor
GuiCursormCursors [NumCursors]
S32 mLastHitMode
Point2I mLastMousePoint

Member Typedef Documentation

Reimplemented from GuiBitmapCtrl.


Member Enumeration Documentation

anonymous enum [private]

Enumerator:
DefaultCursor 
HandCursor 
GrabCursor 
VertResizeCursor 
HorizResizeCursor 
DiagRightResizeCursor 
DiagLeftResizeCursor 
NumCursors 

anonymous enum [private]

Enumerator:
NUT_SIZE 

anonymous enum [private]

Enumerator:
nothing 
sizingLeft 
sizingRight 
sizingTop 
sizingBottom 
moving 


Constructor & Destructor Documentation

MissionAreaEditor::MissionAreaEditor (  ) 


Member Function Documentation

GBitmap* MissionAreaEditor::createTerrainBitmap (  )  [private]

void MissionAreaEditor::onUpdate (  )  [private]

void MissionAreaEditor::setControlObjPos ( const Point2F pos  )  [private]

bool MissionAreaEditor::clampArea ( RectI area  )  [private]

Point2F MissionAreaEditor::worldToScreen ( const Point2F  )  [private]

Point2F MissionAreaEditor::screenToWorld ( const Point2F  )  [private]

void MissionAreaEditor::getScreenMissionArea ( RectI rect  )  [private]

void MissionAreaEditor::getScreenMissionArea ( RectF rect  )  [private]

void MissionAreaEditor::setupScreenTransform ( const Point2I offset  )  [private]

bool MissionAreaEditor::grabCursors (  )  [private]

void MissionAreaEditor::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 modifyer keys (ie ctrl, shift, alt etc)

Reimplemented from GuiControl.

void MissionAreaEditor::setCursor ( U32  cursor  )  [private]

void MissionAreaEditor::updateCursor ( S32  hit  )  [private]

bool MissionAreaEditor::inNut ( const Point2I pt,
S32  x,
S32  y 
) [private]

S32 MissionAreaEditor::getSizingHitKnobs ( const Point2I pt,
const RectI box 
) [private]

void MissionAreaEditor::drawNut ( const Point2I nut  )  [private]

void MissionAreaEditor::drawNuts ( RectI box  )  [private]

bool MissionAreaEditor::missionAreaObjValid (  )  [inline]

bool MissionAreaEditor::terrainObjValid (  )  [inline]

TerrainBlock* MissionAreaEditor::getTerrainObj (  ) 

const RectI& MissionAreaEditor::getArea (  ) 

void MissionAreaEditor::setArea ( const RectI area  ) 

void MissionAreaEditor::updateTerrainBitmap (  ) 

void MissionAreaEditor::parentResized ( const Point2I oldParentExtent,
const Point2I newParentExtent 
) [virtual]

Called when this objects parent is resized.

Parameters:
oldParentExtent The old size of the parent object
newParentExtent The new size of the parent object

Reimplemented from GuiControl.

void MissionAreaEditor::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 GuiBitmapCtrl.

bool MissionAreaEditor::onWake (  )  [virtual]

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

Reimplemented from GuiBitmapCtrl.

void MissionAreaEditor::onSleep (  )  [virtual]

Called when this object is asked to sleep.

Reimplemented from GuiBitmapCtrl.

void MissionAreaEditor::onMouseUp ( const GuiEvent event  )  [virtual]

Reimplemented from GuiControl.

void MissionAreaEditor::onMouseDown ( const GuiEvent event  )  [virtual]

Reimplemented from GuiControl.

void MissionAreaEditor::onMouseMove ( const GuiEvent event  )  [virtual]

Reimplemented from GuiControl.

void MissionAreaEditor::onMouseDragged ( const GuiEvent event  )  [virtual]

Reimplemented from GuiControl.

void MissionAreaEditor::onMouseEnter ( const GuiEvent event  )  [virtual]

Reimplemented from GuiControl.

void MissionAreaEditor::onMouseLeave ( const GuiEvent event  )  [virtual]

Reimplemented from GuiControl.

bool MissionAreaEditor::onAdd (  )  [virtual]

Called when this object is added to the scene.

Reimplemented from GuiControl.

static void MissionAreaEditor::initPersistFields (  )  [static]

Register dynamic fields in a subclass of ConsoleObject.

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

Reimplemented from GuiBitmapCtrl.

MissionAreaEditor::DECLARE_CONOBJECT ( MissionAreaEditor   ) 


Field Documentation

GuiCursor* MissionAreaEditor::mCursors[NumCursors] [private]




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