TerrainEditor Class Reference

#include <terrainEditor.h>

Inheritance diagram for TerrainEditor:


Public Member Functions
void	attachTerrain (TerrainBlock *terrBlock)
void	detachTerrain (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)
TerrainBlock *	getActiveTerrain ()
	TerrainEditor ()
	~TerrainEditor ()
bool	isMainTile (const Point2I &gPos)
TerrainBlock *	getTerrainUnderWorldPoint (const Point3F &wPos)
bool	gridToWorld (const GridPoint &gPoint, Point3F &wPos)
bool	gridToWorld (const Point2I &gPos, Point3F &wPos, TerrainBlock *terrain)
bool	worldToGrid (const Point3F &wPos, GridPoint &gPoint)
bool	worldToGrid (const Point3F &wPos, Point2I &gPos, TerrainBlock *terrain=NULL)
bool	gridToCenter (const Point2I &gPos, Point2I &cPos)
bool	getGridInfo (const GridPoint &gPoint, GridInfo &info)
bool	getGridInfo (const Point2I &gPos, GridInfo &info, TerrainBlock *terrain)
void	getGridInfos (const GridPoint &gPoint, Vector< GridInfo > &infos)
void	setGridInfo (const GridInfo &info, bool checkActive=false)
void	setGridInfoHeight (const GridInfo &info)
void	gridUpdateComplete ()
void	materialUpdateComplete ()
void	processActionTick (U32 sequence)
TerrainBlock *	collide (const Gui3DMouseEvent &event, Point3F &pos)
void	lockSelection (bool lock)
Selection *	getUndoSel ()
Selection *	getCurrentSel ()
void	setCurrentSel (Selection *sel)
void	resetCurrentSel ()
S32	getPaintMaterial ()
Point2I	getBrushSize ()
TerrainBlock *	getClientTerrain (TerrainBlock *serverTerrain)
bool	terrainBlockValid ()
void	setCursor (GuiCursor *cursor)
void	getCursor (GuiCursor *&cursor, bool &showCursor, const GuiEvent &lastGuiEvent)
	Get information about the cursor.
void	setDirty ()
void	setMissionDirty ()
TerrainAction *	lookupAction (const char *name)
bool	onAdd ()
	Called when this object is added to the scene.
void	onDeleteNotify (SimObject *object)
	Called when the mProfile or mToolTipProfile is deleted.
virtual void	on3DMouseUp (const Gui3DMouseEvent &event)
virtual void	on3DMouseDown (const Gui3DMouseEvent &event)
virtual void	on3DMouseMove (const Gui3DMouseEvent &event)
virtual void	on3DMouseDragged (const Gui3DMouseEvent &event)
virtual void	on3DMouseWheelUp (const Gui3DMouseEvent &event)
virtual void	on3DMouseWheelDown (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.
Public Attributes
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
Point2I	mMaxBrushSize
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 GridPoint &gPoint)
void	setGridHeight (const GridPoint &gPoint, const F32 height)
TerrainBlock::Material	getGridMaterial (const GridPoint &gPoint)
void	setGridMaterial (const GridPoint &gPoint, const TerrainBlock::Material &material)
U8	getGridMaterialGroup (const GridPoint &gPoint)
void	setGridMaterialGroup (const GridPoint &gPoint, 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
TerrainBlock *	mActiveTerrain
VectorPtr< TerrainBlock * >	mTerrainBlocks
Point2I	mGridUpdateMin
Point2I	mGridUpdateMax
U32	mMouseDownSeq
Point3F	mMousePos
Brush *	mMouseBrush
bool	mRenderBrush
Point2I	mBrushSize
Vector< TerrainAction * >	mActions
TerrainAction *	mCurrentAction
bool	mInAction
Selection	mDefaultSel
bool	mSelectionLocked
GuiCursor *	mDefaultCursor
GuiCursor *	mCurrentCursor
bool	mCursorVisible
StringTableEntry	mPaintMaterial
Selection *	mCurrentSel
bool	mRebuildEmpty
bool	mRebuildTextures
U32	mUndoLimit
Selection *	mUndoSel
Vector< Selection * >	mUndoList
Vector< Selection * >	mRedoList
Vector< BaseMaterialInfo * >	mBaseMaterialInfos
bool	mIsDirty
bool	mIsMissionDirty
GFXStateBlockRef	mStateBlock

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::detachTerrain ( 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 )

TerrainBlock* TerrainEditor::getActiveTerrain ( ) [inline, virtual]

Reimplemented from EditTSCtrl.

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::isMainTile ( const Point2I & gPos )

TerrainBlock* TerrainEditor::getTerrainUnderWorldPoint ( const Point3F & wPos )

bool TerrainEditor::gridToWorld	(	const GridPoint &	gPoint,
		Point3F &	wPos
	)

bool TerrainEditor::gridToWorld	(	const Point2I &	gPos,
		Point3F &	wPos,
		TerrainBlock *	terrain
	)

bool TerrainEditor::worldToGrid	(	const Point3F &	wPos,
		GridPoint &	gPoint
	)

bool TerrainEditor::worldToGrid	(	const Point3F &	wPos,
		Point2I &	gPos,
		TerrainBlock *	terrain = `NULL`
	)

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

bool TerrainEditor::getGridInfo	(	const GridPoint &	gPoint,
		GridInfo &	info
	)

bool TerrainEditor::getGridInfo	(	const Point2I &	gPos,
		GridInfo &	info,
		TerrainBlock *	terrain
	)

void TerrainEditor::getGridInfos	(	const GridPoint &	gPoint,
		Vector< GridInfo > &	infos
	)

void TerrainEditor::setGridInfo	(	const GridInfo &	info,
		bool	checkActive = `false`
	)

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

void TerrainEditor::gridUpdateComplete ( )

void TerrainEditor::materialUpdateComplete ( )

void TerrainEditor::processActionTick ( U32 sequence )

TerrainBlock* 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::getClientTerrain ( TerrainBlock * serverTerrain )

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 modifier 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 GridPoint & gPoint ) [private]

void TerrainEditor::setGridHeight	(	const GridPoint &	gPoint,
		const F32	height
	)			`[private]`

TerrainBlock::Material TerrainEditor::getGridMaterial ( const GridPoint & gPoint ) [private]

void TerrainEditor::setGridMaterial	(	const GridPoint &	gPoint,
		const TerrainBlock::Material &	material
	)			`[private]`

U8 TerrainEditor::getGridMaterialGroup ( const GridPoint & gPoint ) [private]

void TerrainEditor::setGridMaterialGroup	(	const GridPoint &	gPoint,
		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]`