proland::Editor Class Reference
[edit]

Abstract interface of objects that can be edited with an EditorHandler. More...

#include <EditorHandler.h>

Inheritance diagram for proland::Editor:
proland::EditElevationProducer proland::EditOrthoProducer

List of all members.

Public Member Functions

virtual SceneNode * getTerrain ()=0
 Returns the SceneNode defining the position of the terrain edited by this Editor.
virtual TerrainNode * getTerrainNode ()=0
 Returns the TerrainNode defining the terrain edited by this Editor.
virtual void setPencil (const vec4f &pencil, const vec4f &brushColor, bool paint)=0
 Notifies this Editor of a new position of the paint brush.
virtual vec4f getBrushColor ()=0
 Returns the current brush color.
virtual void edit (const vector< vec4d > &strokes)=0
 Notifies this Editor that a new stroke has been added to the shape being painted on the terrain.
virtual void update ()=0
 Notifies this Editor that the user has finished painting a shape on the terrain.

Detailed Description

Abstract interface of objects that can be edited with an EditorHandler.

An Editor is associated with a terrain, and is used to edit some attributes of this terrain via painting (elevation, texture, etc).

Authors:
Eric Bruneton, Antoine Begault, Guillaume Piolat

Member Function Documentation

virtual void proland::Editor::edit ( const vector< vec4d > &  strokes  )  [pure virtual]

Notifies this Editor that a new stroke has been added to the shape being painted on the terrain.

Parameters:
strokes the samples that have been taken along the shape that the user is currently painting on the terrain. Each sample contains a position and a radius (in world space).

Implemented in proland::EditElevationProducer, and proland::EditOrthoProducer.

virtual vec4f proland::Editor::getBrushColor (  )  [pure virtual]

Returns the current brush color.

Implemented in proland::EditElevationProducer, and proland::EditOrthoProducer.

virtual SceneNode* proland::Editor::getTerrain (  )  [pure virtual]

Returns the SceneNode defining the position of the terrain edited by this Editor.

Implemented in proland::EditElevationProducer, and proland::EditOrthoProducer.

virtual TerrainNode* proland::Editor::getTerrainNode (  )  [pure virtual]

Returns the TerrainNode defining the terrain edited by this Editor.

Implemented in proland::EditElevationProducer, and proland::EditOrthoProducer.

virtual void proland::Editor::setPencil ( const vec4f &  pencil,
const vec4f &  brushColor,
bool  paint 
) [pure virtual]

Notifies this Editor of a new position of the paint brush.

Parameters:
pencil a position in world space, and a radius (in world space).
brushColor value that will be written by the brush.
paint true if the user is currently painting.

Implemented in proland::EditElevationProducer, and proland::EditOrthoProducer.

virtual void proland::Editor::update (  )  [pure virtual]

Notifies this Editor that the user has finished painting a shape on the terrain.

Implemented in proland::EditElevationProducer, and proland::EditOrthoProducer.


Generated on Sat May 12 09:43:14 2012 for proland by  doxygen 1.6.1