diguyAuthorVisualRegionPaintbrush Class Reference

#include <diguyAuthorVisualRegionPaintbrush.h>

Public Member Functions
diguyAuthorVisualMaterial *	get_visual_material ()
	Returns the visual material to be used for rendering this object. More...
diguyVec3f	get_position ()
	Returns the current position of the paintbrush in meters from the DI-Guy origin. More...
diguySubregionIndex	get_painting_subregion ()
	Returns the index of the subregion the paintbrush will paint into. More...
void	set_painting_subregion (diguySubregionIndex subregion_index)
	Sets the index of the subregion the paintbrush will paint into. More...
diguyRegionPaintbrushMode	get_paintrush_mode ()
	Returns the current paintbrush mode, a diguyRegionPaintbrushMode enumeration value. More...
void	set_paintrush_mode (diguyRegionPaintbrushMode mode)
	Sets what happens when a paintbrush stroke is applied in input modes DIGUY_SCENARIO_INPUT_MODE_REGION_PAINTER and DIGUY_SCENARIO_INPUT_MODE_CROWD_EDITOR. More...
float	get_brush_size ()
	Returns the radius of the paintbrush. More...
void	set_brush_size (float radius)
	Sets the radius of the paintbrush. More...
int	get_brush_is_eraser ()
	Returns 1 if the paintbrush should be shown as an eraser, else 0. More...
int	get_visible ()
	Returns 1 if this visual should be visible, else 0. More...
virtual void	build ()
	See diguyAuthorVisualWaypoint::build() for general information about this function. More...
virtual void	unbuild ()
	See diguyAuthorVisualWaypoint::unbuild() for general information about this function. More...
virtual void	update (int update_flags)
	See diguyAuthorVisualWaypoint::update() for general information about this function. More...
virtual void	draw ()
	See diguyAuthorVisualWaypoint::draw() for general information about this function. More...
virtual void	show ()
	See diguyAuthorVisualWaypoint::show() for general information about this function. More...
virtual void	hide ()
	See diguyAuthorVisualWaypoint::hide() for general information about this function. More...

Private Functions
The functions and variables past this point are for internal use only. No external access to them is expected or necessary.
static diguyAuthorVisualRegionPaintbrushCreateFunc *	s_create_func
bdiNavMeshInterface *	m_scripted_object
diguyAuthorVisualMaterial *	m_visual_material
class	bdiNavMesh
class	bdiNavMeshInterface
	diguyAuthorVisualRegionPaintbrush (void *internal_data)
virtual	~diguyAuthorVisualRegionPaintbrush ()
bdiNavMeshInterface *	get_scripted_object ()

Constructor & Destructor Documentation

diguyAuthorVisualRegionPaintbrush::diguyAuthorVisualRegionPaintbrush ( void *  internal_data )

protected

virtual diguyAuthorVisualRegionPaintbrush::~diguyAuthorVisualRegionPaintbrush ( )

protectedvirtual

Member Function Documentation

diguyAuthorVisualMaterial* diguyAuthorVisualRegionPaintbrush::get_visual_material

(

)

Returns the visual material to be used for rendering this object.

diguyVec3f diguyAuthorVisualRegionPaintbrush::get_position

(

)

Returns the current position of the paintbrush in meters from the DI-Guy origin.

diguySubregionIndex diguyAuthorVisualRegionPaintbrush::get_painting_subregion

(

)

Returns the index of the subregion the paintbrush will paint into.

This will be a diguySubregionIndex enumeration value.

void diguyAuthorVisualRegionPaintbrush::set_painting_subregion

(

diguySubregionIndex

subregion_index

)

Sets the index of the subregion the paintbrush will paint into.

diguyRegionPaintbrushMode diguyAuthorVisualRegionPaintbrush::get_paintrush_mode

(

)

Returns the current paintbrush mode, a diguyRegionPaintbrushMode enumeration value.

void diguyAuthorVisualRegionPaintbrush::set_paintrush_mode

(

diguyRegionPaintbrushMode

mode

)

Sets what happens when a paintbrush stroke is applied in input modes DIGUY_SCENARIO_INPUT_MODE_REGION_PAINTER and DIGUY_SCENARIO_INPUT_MODE_CROWD_EDITOR.

float diguyAuthorVisualRegionPaintbrush::get_brush_size

(

)

Returns the radius of the paintbrush.

void diguyAuthorVisualRegionPaintbrush::set_brush_size

(

float

radius

)

Sets the radius of the paintbrush.

int diguyAuthorVisualRegionPaintbrush::get_brush_is_eraser

(

)

Returns 1 if the paintbrush should be shown as an eraser, else 0.

int diguyAuthorVisualRegionPaintbrush::get_visible

(

)

Returns 1 if this visual should be visible, else 0.

virtual void diguyAuthorVisualRegionPaintbrush::build ( )

virtual

See diguyAuthorVisualWaypoint::build() for general information about this function.

virtual void diguyAuthorVisualRegionPaintbrush::unbuild ( )

virtual

See diguyAuthorVisualWaypoint::unbuild() for general information about this function.

virtual void diguyAuthorVisualRegionPaintbrush::update ( int  update_flags )

virtual

See diguyAuthorVisualWaypoint::update() for general information about this function.

DIGUY_GRAPHICS_VISUAL_UPDATE_GEOMETRY

 Paintbrushes are commonly shown as translucent spheres when they
 will add to the region, or a yellow pencil-like column when they
 will erase from the region.

virtual void diguyAuthorVisualRegionPaintbrush::draw ( )

virtual

See diguyAuthorVisualWaypoint::draw() for general information about this function.

virtual void diguyAuthorVisualRegionPaintbrush::show ( )

virtual

See diguyAuthorVisualWaypoint::show() for general information about this function.

virtual void diguyAuthorVisualRegionPaintbrush::hide ( )

virtual

See diguyAuthorVisualWaypoint::hide() for general information about this function.

bdiNavMeshInterface* diguyAuthorVisualRegionPaintbrush::get_scripted_object ( )

inlineprotected

Friends And Related Function Documentation

friend class bdiNavMesh

friend

friend class bdiNavMeshInterface

friend

Member Data Documentation

diguyAuthorVisualRegionPaintbrushCreateFunc* diguyAuthorVisualRegionPaintbrush::s_create_func

static

bdiNavMeshInterface* diguyAuthorVisualRegionPaintbrush::m_scripted_object

protected

diguyAuthorVisualMaterial* diguyAuthorVisualRegionPaintbrush::m_visual_material

protected

---

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

• E:/nightly/2751/include/diguyAuthorVisualRegionPaintbrush.h