torque Torque Game Engine Documentation
TGE Version 1.5.2

TerrainEditor Class Reference

#include <terrainEditor.h>

Inheritance diagram for TerrainEditor:

Inheritance graph
[legend]

Public Member Functions

void attachTerrain (TerrainBlock *terrBlock)
void setBrushType (const char *type)
void setBrushSize (S32 w, S32 h)
const char * getBrushPos ()
void setBrushPos (Point2I pos)
void setAction (const char *action)
const char * getActionName (U32 index)
const char * getCurrentAction ()
S32 getNumActions ()
void processAction (const char *sAction)
void undo ()
void redo ()
void resetSelWeights (bool clear)
void clearSelection ()
void buildMaterialMap ()
S32 getNumTextures ()
const char * getTextureName (S32 index)
void markEmptySquares ()
void clearModifiedFlags ()
void mirrorTerrain (S32 mirrorIndex)
void pushBaseMaterialInfo ()
void popBaseMaterialInfo ()
void setLoneBaseMaterial (const char *materialListBaseName)
 TerrainEditor ()
 ~TerrainEditor ()
bool gridToWorld (const Point2I &gPos, Point3F &wPos)
bool worldToGrid (const Point3F &wPos, Point2I &gPos)
bool gridToCenter (const Point2I &gPos, Point2I &cPos)
bool getGridInfo (const Point3F &wPos, GridInfo &info)
bool getGridInfo (const Point2I &gPos, GridInfo &info)
void setGridInfo (const GridInfo &info)
void setGridInfoHeight (const GridInfo &info)
void gridUpdateComplete ()
void materialUpdateComplete ()
void processActionTick (U32 sequence)
bool collide (const Gui3DMouseEvent &event, Point3F &pos)
void lockSelection (bool lock)
SelectiongetUndoSel ()
SelectiongetCurrentSel ()
void setCurrentSel (Selection *sel)
void resetCurrentSel ()
S32 getPaintMaterial ()
Point2I getBrushSize ()
TerrainBlockgetTerrainBlock ()
TerrainBlockgetClientTerrain ()
bool terrainBlockValid ()
void setCursor (GuiCursor *cursor)
void getCursor (GuiCursor *&cursor, bool &showCursor, const GuiEvent &lastGuiEvent)
 Get information about the cursor.
void setDirty ()
void setMissionDirty ()
TerrainActionlookupAction (const char *name)
bool onAdd ()
 Called when this object is added to the scene.
void onDeleteNotify (SimObject *object)
 Called when a SimObject is deleted.
void on3DMouseUp (const Gui3DMouseEvent &event)
void on3DMouseDown (const Gui3DMouseEvent &event)
void on3DMouseMove (const Gui3DMouseEvent &event)
void on3DMouseDragged (const Gui3DMouseEvent &event)
void updateGuiInfo ()
void renderScene (const RectI &updateRect)
 DECLARE_CONOBJECT (TerrainEditor)

Static Public Member Functions

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

Data Fields

bool mRenderBorder
F32 mBorderHeight
ColorI mBorderFillColor
ColorI mBorderFrameColor
bool mBorderLineMode
bool mSelectionHidden
bool mEnableSoftBrushes
bool mRenderVertexSelection
bool mProcessUsesBrush
F32 mAdjustHeightVal
F32 mSetHeightVal
F32 mScaleVal
F32 mSmoothFactor
S32 mMaterialGroup
F32 mSoftSelectRadius
StringTableEntry mSoftSelectFilter
StringTableEntry mSoftSelectDefaultFilter
F32 mAdjustHeightMouseScale

Private Types

typedef EditTSCtrl Parent

Private Member Functions

void rebuild ()
void addUndo (Vector< Selection * > &list, Selection *sel)
bool processUndo (Vector< Selection * > &src, Vector< Selection * > &dest)
void clearUndo (Vector< Selection * > &list)
F32 getGridHeight (const Point2I &gPos)
void setGridHeight (const Point2I &gPos, const F32 height)
TerrainBlock::Material getGridMaterial (const Point2I &gPos)
void setGridMaterial (const Point2I &gPos, const TerrainBlock::Material &material)
U8 getGridMaterialGroup (const Point2I &gPos)
void setGridMaterialGroup (const Point2I &gPos, U8 group)
void updateBrush (Brush &brush, const Point2I &gPos)
Point3F getMousePos ()
void renderSelection (const Selection &sel, const ColorF &inColorFull, const ColorF &inColorNone, const ColorF &outColorFull, const ColorF &outColorNone, bool renderFill, bool renderFrame)
void renderBorder ()

Private Attributes

TerrainBlockmTerrainBlock
Point2I mGridUpdateMin
Point2I mGridUpdateMax
U32 mMouseDownSeq
Point3F mMousePos
BrushmMouseBrush
bool mRenderBrush
Point2I mBrushSize
Vector< TerrainAction * > mActions
TerrainActionmCurrentAction
bool mInAction
Selection mDefaultSel
bool mSelectionLocked
GuiCursormDefaultCursor
GuiCursormCurrentCursor
bool mCursorVisible
StringTableEntry mPaintMaterial
SelectionmCurrentSel
bool mRebuildEmpty
bool mRebuildTextures
U32 mUndoLimit
SelectionmUndoSel
Vector< Selection * > mUndoList
Vector< Selection * > mRedoList
Vector< BaseMaterialInfo * > mBaseMaterialInfos
bool mIsDirty
bool mIsMissionDirty

Member Typedef Documentation

typedef EditTSCtrl TerrainEditor::Parent [private]

Reimplemented from EditTSCtrl.


Constructor & Destructor Documentation

TerrainEditor::TerrainEditor (  ) 

TerrainEditor::~TerrainEditor (  ) 


Member Function Documentation

void TerrainEditor::attachTerrain ( TerrainBlock terrBlock  ) 

void TerrainEditor::setBrushType ( const char *  type  ) 

void TerrainEditor::setBrushSize ( S32  w,
S32  h 
)

const char* TerrainEditor::getBrushPos (  ) 

void TerrainEditor::setBrushPos ( Point2I  pos  ) 

void TerrainEditor::setAction ( const char *  action  ) 

const char* TerrainEditor::getActionName ( U32  index  ) 

const char* TerrainEditor::getCurrentAction (  ) 

S32 TerrainEditor::getNumActions (  ) 

void TerrainEditor::processAction ( const char *  sAction  ) 

void TerrainEditor::undo (  ) 

void TerrainEditor::redo (  ) 

void TerrainEditor::resetSelWeights ( bool  clear  ) 

void TerrainEditor::clearSelection (  ) 

void TerrainEditor::buildMaterialMap (  ) 

S32 TerrainEditor::getNumTextures (  ) 

const char* TerrainEditor::getTextureName ( S32  index  ) 

void TerrainEditor::markEmptySquares (  ) 

void TerrainEditor::clearModifiedFlags (  ) 

void TerrainEditor::mirrorTerrain ( S32  mirrorIndex  ) 

void TerrainEditor::pushBaseMaterialInfo (  ) 

void TerrainEditor::popBaseMaterialInfo (  ) 

void TerrainEditor::setLoneBaseMaterial ( const char *  materialListBaseName  ) 

void TerrainEditor::rebuild (  )  [private]

void TerrainEditor::addUndo ( Vector< Selection * > &  list,
Selection sel 
) [private]

bool TerrainEditor::processUndo ( Vector< Selection * > &  src,
Vector< Selection * > &  dest 
) [private]

void TerrainEditor::clearUndo ( Vector< Selection * > &  list  )  [private]

bool TerrainEditor::gridToWorld ( const Point2I gPos,
Point3F wPos 
)

bool TerrainEditor::worldToGrid ( const Point3F wPos,
Point2I gPos 
)

bool TerrainEditor::gridToCenter ( const Point2I gPos,
Point2I cPos 
)

bool TerrainEditor::getGridInfo ( const Point3F wPos,
GridInfo info 
)

bool TerrainEditor::getGridInfo ( const Point2I gPos,
GridInfo info 
)

void TerrainEditor::setGridInfo ( const GridInfo info  ) 

void TerrainEditor::setGridInfoHeight ( const GridInfo info  )  [inline]

void TerrainEditor::gridUpdateComplete (  ) 

void TerrainEditor::materialUpdateComplete (  ) 

void TerrainEditor::processActionTick ( U32  sequence  ) 

bool TerrainEditor::collide ( const Gui3DMouseEvent event,
Point3F pos 
)

void TerrainEditor::lockSelection ( bool  lock  )  [inline]

Selection* TerrainEditor::getUndoSel (  )  [inline]

Selection* TerrainEditor::getCurrentSel (  )  [inline]

void TerrainEditor::setCurrentSel ( Selection sel  )  [inline]

void TerrainEditor::resetCurrentSel (  )  [inline]

S32 TerrainEditor::getPaintMaterial (  ) 

Point2I TerrainEditor::getBrushSize (  )  [inline]

TerrainBlock* TerrainEditor::getTerrainBlock (  )  [inline]

TerrainBlock* TerrainEditor::getClientTerrain (  ) 

bool TerrainEditor::terrainBlockValid (  )  [inline]

void TerrainEditor::setCursor ( GuiCursor cursor  ) 

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

void TerrainEditor::setDirty (  )  [inline]

void TerrainEditor::setMissionDirty (  )  [inline]

TerrainAction* TerrainEditor::lookupAction ( const char *  name  ) 

F32 TerrainEditor::getGridHeight ( const Point2I gPos  )  [private]

void TerrainEditor::setGridHeight ( const Point2I gPos,
const F32  height 
) [private]

TerrainBlock::Material TerrainEditor::getGridMaterial ( const Point2I gPos  )  [private]

void TerrainEditor::setGridMaterial ( const Point2I gPos,
const TerrainBlock::Material material 
) [private]

U8 TerrainEditor::getGridMaterialGroup ( const Point2I gPos  )  [private]

void TerrainEditor::setGridMaterialGroup ( const Point2I gPos,
U8  group 
) [private]

void TerrainEditor::updateBrush ( Brush brush,
const Point2I gPos 
) [private]

Point3F TerrainEditor::getMousePos (  )  [inline, private]

void TerrainEditor::renderSelection ( const Selection sel,
const ColorF inColorFull,
const ColorF inColorNone,
const ColorF outColorFull,
const ColorF outColorNone,
bool  renderFill,
bool  renderFrame 
) [private]

void TerrainEditor::renderBorder (  )  [private]

bool TerrainEditor::onAdd (  )  [virtual]

Called when this object is added to the scene.

Reimplemented from EditTSCtrl.

void TerrainEditor::onDeleteNotify ( SimObject object  )  [virtual]

Called when a SimObject is deleted.

When you are on the notification list for another object and it is deleted, this method is called.

Reimplemented from SimSet.

static void TerrainEditor::initPersistFields (  )  [static]

Register dynamic fields in a subclass of ConsoleObject.

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

Reimplemented from EditTSCtrl.

void TerrainEditor::on3DMouseUp ( const Gui3DMouseEvent event  )  [virtual]

Reimplemented from EditTSCtrl.

void TerrainEditor::on3DMouseDown ( const Gui3DMouseEvent event  )  [virtual]

Reimplemented from EditTSCtrl.

void TerrainEditor::on3DMouseMove ( const Gui3DMouseEvent event  )  [virtual]

Reimplemented from EditTSCtrl.

void TerrainEditor::on3DMouseDragged ( const Gui3DMouseEvent event  )  [virtual]

Reimplemented from EditTSCtrl.

void TerrainEditor::updateGuiInfo (  )  [virtual]

Reimplemented from EditTSCtrl.

void TerrainEditor::renderScene ( const RectI updateRect  )  [virtual]

Reimplemented from EditTSCtrl.

TerrainEditor::DECLARE_CONOBJECT ( TerrainEditor   ) 


Field Documentation

bool TerrainEditor::mInAction [private]

bool TerrainEditor::mIsDirty [private]




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