Torque3D Documentation / _generateds / ForestBrushTool

ForestBrushTool

Engine/source/forest/editor/forestBrushTool.h

More...

Public Types

enum
BrushMode {
  Paint = 0
  Erase 
  EraseSelected 
}

Private Types

ForestTool

Parent

Public Friends

class

ForestBrushToolEvent

Protected Attributes

bool

mBrushDown 

ColorI

mColor 

ForestUndoAction *

mCurrAction

The creation action we're actively filling.

Vector< ForestItemData * >

mDatablocks 

bool

mDrawBrush 

Vector< ForestBrushElement * >

mElements 

F32

mHardness 

Point3F

mLastBrushNormal 

Point3F

mLastBrushPoint 

U32

mMode 

F32

mPressure 

MRandom

mRandom 

F32

mSize

We treat this as a radius.

U32

mStrokeEvent

Public Functions

ForestBrushTool()

~ForestBrushTool()

void

collectElements()

DECLARE_CONOBJECT(ForestBrushTool )

bool

getGroundAt(const Point3F & worldPt, F32 * zValueOut, VectorF * normalOut)

void

on3DMouseDown(const Gui3DMouseEvent & evt)

void

on3DMouseDragged(const Gui3DMouseEvent & evt)

void

on3DMouseMove(const Gui3DMouseEvent & evt)

void

on3DMouseUp(const Gui3DMouseEvent & evt)

void

onActivated(const Gui3DMouseEvent & lastEvent)

bool

onAdd()

Called when the object is added to the sim.
void

onDeactivated()

bool

onMouseWheel(const GuiEvent & evt)

void

onRemove()

Called when the object is removed from the sim.
void

onRender2D()

void

onRender3D()

void

setHardness(F32 val)

void

setPressure(F32 val)

void

setSize(F32 val)

bool

updateGuiInfo()

Public Static Functions
void

initPersistFields()

Protected Functions
void

_action(const Point3F & point)

void

_collectElements()

void

_erase(const Point3F & point)

void

_onStroke()

void

_paint(const Point3F & point)

bool

_updateBrushPoint(const Gui3DMouseEvent & event_)

Protected Static Functions
bool

protectedSetHardness(void * object, const char * index, const char * data)

bool

protectedSetPressure(void * object, const char * index, const char * data)

bool

protectedSetSize(void * object, const char * index, const char * data)

Detailed Description
Public Types
BrushMode

Enumerator
Paint = 0
Erase 
EraseSelected 
Private Types
typedef ForestTool Parent 

Public Friends
Protected Attributes
bool mBrushDown 

ColorI mColor 

ForestUndoAction * mCurrAction 

The creation action we're actively filling.
Vector< ForestItemData * > mDatablocks 

bool mDrawBrush 

Vector< ForestBrushElement * > mElements 

F32 mHardness 

Point3F mLastBrushNormal 

Point3F mLastBrushPoint 

U32 mMode 

F32 mPressure 

MRandom mRandom 

F32 mSize 

We treat this as a radius.
U32 mStrokeEvent 

Public Functions
ForestBrushTool()

~ForestBrushTool()

collectElements()

DECLARE_CONOBJECT(ForestBrushTool )

getGroundAt(const Point3F & worldPt, F32 * zValueOut, VectorF * normalOut)

on3DMouseDown(const Gui3DMouseEvent & evt)

Reimplemented from: ForestTool
on3DMouseDragged(const Gui3DMouseEvent & evt)

Reimplemented from: ForestTool
on3DMouseMove(const Gui3DMouseEvent & evt)

Reimplemented from: ForestTool
on3DMouseUp(const Gui3DMouseEvent & evt)

Reimplemented from: ForestTool
onActivated(const Gui3DMouseEvent & lastEvent)

Reimplemented from: ForestTool
onAdd()

Reimplemented from: SimObject
onDeactivated()

Reimplemented from: ForestTool
onMouseWheel(const GuiEvent & evt)

Reimplemented from: ForestTool
onRemove()

Reimplemented from: SimObject
onRender2D()

Reimplemented from: ForestTool
onRender3D()

Reimplemented from: ForestTool
setHardness(F32 val)

setPressure(F32 val)

setSize(F32 val)

updateGuiInfo()

Reimplemented from: ForestTool
Public Static Functions
initPersistFields()

Protected Functions
_action(const Point3F & point)

_collectElements()

_erase(const Point3F & point)

_onStroke()

_paint(const Point3F & point)

_updateBrushPoint(const Gui3DMouseEvent & event_)

Protected Static Functions
protectedSetHardness(void * object, const char * index, const char * data)

protectedSetPressure(void * object, const char * index, const char * data)

protectedSetSize(void * object, const char * index, const char * data)