RampTool Class Reference

#include <RampTool.h>

Inherits Tool.

Public Member Functions
	RampTool ()
virtual void	activate ()
	Become the current tool.
virtual void	deactivate ()
	Become not the current tool.
virtual Bool	followsTerrain (void)
	Become not the current tool.
virtual void	mouseMoved (TTrackingMode m, CPoint viewPt, WbView *pView, CWorldBuilderDoc *pDoc)
	True if the tool tracks the terrain, generally false if it modifies the terrain heights.
virtual void	mouseDown (TTrackingMode m, CPoint viewPt, WbView *pView, CWorldBuilderDoc *pDoc)
virtual void	mouseUp (TTrackingMode m, CPoint viewPt, WbView *pView, CWorldBuilderDoc *pDoc)
Public Member Functions inherited from Tool
	Tool (Int toolID, Int cursorID)
	Tool class.
virtual	~Tool (void)
	Destructor.
Int	getToolID (void)
virtual void	setCursor (void)
virtual WorldHeightMapEdit *	getHeightMap (void)

Protected Member Functions
void	drawFeedback (Coord3D *endPoint)
void	applyRamp (CWorldBuilderDoc *pDoc)

Additional Inherited Members
Static Public Member Functions inherited from Tool
static Real	calcRoundBlendFactor (CPoint center, Int x, Int y, Int brushWidth, Int featherWidth)
	Calculate the round blend factor.
static Real	calcSquareBlendFactor (CPoint center, Int x, Int y, Int brushWidth, Int featherWidth)
	Calculate the square blend factor.
static void	getCenterIndex (Coord3D *docLocP, Int brushWidth, CPoint *center, CWorldBuilderDoc *pDoc)
	Gets the cell index for the center of the brush.
static void	getAllIndexesIn (const Coord3D *bl, const Coord3D *br, const Coord3D *tl, const Coord3D *tr, Int widthOutside, CWorldBuilderDoc *pDoc, VecHeightMapIndexes *allIndices)
Protected Attributes inherited from Tool
Int	m_toolID
Int	m_cursorID
HCURSOR	m_cursor
Int	m_prevXIndex
Int	m_prevYIndex

Detailed Description

Definition at line 44 of file RampTool.h.

Constructor & Destructor Documentation

RampTool()

RampTool::RampTool

(

)

Definition at line 51 of file RampTool.cpp.

Member Function Documentation

activate()

void RampTool::activate ( )

virtual

Become the current tool.

Shows the "no options" options panel.

Reimplemented from Tool.

Definition at line 56 of file RampTool.cpp.

applyRamp()

void RampTool::applyRamp ( CWorldBuilderDoc * pDoc )

protected

Definition at line 128 of file RampTool.cpp.

deactivate()

void RampTool::deactivate ( )

virtual

Become not the current tool.

Reimplemented from Tool.

Definition at line 64 of file RampTool.cpp.

drawFeedback()

void RampTool::drawFeedback ( Coord3D * endPoint )

protected

Definition at line 122 of file RampTool.cpp.

followsTerrain()

Bool RampTool::followsTerrain ( void )

virtual

Become not the current tool.

Reimplemented from Tool.

Definition at line 70 of file RampTool.cpp.

mouseDown()

void RampTool::mouseDown ( TTrackingMode m, CPoint viewPt, WbView * pView, CWorldBuilderDoc * pDoc )

virtual

Reimplemented from Tool.

Definition at line 93 of file RampTool.cpp.

mouseMoved()

void RampTool::mouseMoved ( TTrackingMode m, CPoint viewPt, WbView * pView, CWorldBuilderDoc * pDoc )

virtual

True if the tool tracks the terrain, generally false if it modifies the terrain heights.

Reimplemented from Tool.

Definition at line 75 of file RampTool.cpp.

mouseUp()

void RampTool::mouseUp ( TTrackingMode m, CPoint viewPt, WbView * pView, CWorldBuilderDoc * pDoc )

virtual

Reimplemented from Tool.

Definition at line 107 of file RampTool.cpp.

---

The documentation for this class was generated from the following files:

• Code/Tools/WorldBuilder/include/RampTool.h
• Code/Tools/WorldBuilder/src/RampTool.cpp