diguyAuthorVisualMultiline Class Reference

The diguyAuthorVisualMultiline class provides an interface for creating supplemental visuals needed for creating DI-Guy scenarios in a Host App. More...

#include <diguyAuthorVisualMultiline.h>

Public Member Functions
diguyAuthorVisualMaterial *	get_visual_material ()
	Returns the visual material to be used for rendering this object. More...
int	get_num_points ()
diguyVec3f	get_point_position (int point_number)
diguyVec3d	get_point_position_double (int point_number)
long	get_uid ()
	Returns the uid (unique identifier) of this multiline. More...
int	get_visible ()
	Returns 1 if this visual should be visible, else 0. More...
Virtual Functions
The functions in this section are all virtual functions that will be called by DI-Guy Author at various times during DI-Guy execution. Because the functions are all virtual, DI-Guy programmers can create a subclass of this class and override them. Unless otherwise stated, the base class functions do not need to be called.
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 diguyAuthorVisualMultilineCreateFunc *	s_create_func
bdiGeometryMultilineData *	m_scripted_object
diguyAuthorVisualMaterial *	m_visual_material
long	m_uid
class	bdiPath
class	bdiGeometryMultilineData
	diguyAuthorVisualMultiline (void *internal_data, long uid)
virtual	~diguyAuthorVisualMultiline ()
bdiGeometryMultilineData *	get_scripted_object ()

Detailed Description

The diguyAuthorVisualMultiline class provides an interface for creating supplemental visuals needed for creating DI-Guy scenarios in a Host App.

Multiline visuals are used for representing the spline curce of character paths.

Link against: libdiguy

Constructor & Destructor Documentation

diguyAuthorVisualMultiline::diguyAuthorVisualMultiline ( void *  internal_data, long  uid  )

protected

virtual diguyAuthorVisualMultiline::~diguyAuthorVisualMultiline ( )

protectedvirtual

Member Function Documentation

diguyAuthorVisualMaterial* diguyAuthorVisualMultiline::get_visual_material

(

)

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

Because multilines have no polygons the brush color of the material is not used.

int diguyAuthorVisualMultiline::get_num_points

(

)

diguyVec3f diguyAuthorVisualMultiline::get_point_position

(

int

point_number

)

diguyVec3d diguyAuthorVisualMultiline::get_point_position_double

(

int

point_number

)

long diguyAuthorVisualMultiline::get_uid

(

)

Returns the uid (unique identifier) of this multiline.

int diguyAuthorVisualMultiline::get_visible

(

)

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

virtual void diguyAuthorVisualMultiline::build ( )

virtual

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

Multilines are mostly represented by renderer line primitives.

virtual void diguyAuthorVisualMultiline::unbuild ( )

virtual

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

virtual void diguyAuthorVisualMultiline::update ( int  update_flags )

virtual

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

DIGUY_GRAPHICS_VISUAL_UPDATE_GEOMETRY

 The functions get_num_points(), get_point_position(), etc.,
 should be used to create line primitives.

DIGUY_GRAPHICS_VISUAL_UPDATE_POSITION

 Multiline visuals do not use this value.  The overall positions
 of line segment endpoints that make up the multiline are
 recomputed and applied during an overall geometry update
 operation.

virtual void diguyAuthorVisualMultiline::draw ( )

virtual

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

virtual void diguyAuthorVisualMultiline::show ( )

virtual

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

virtual void diguyAuthorVisualMultiline::hide ( )

virtual

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

bdiGeometryMultilineData* diguyAuthorVisualMultiline::get_scripted_object ( )

inlineprotected

Friends And Related Function Documentation

friend class bdiPath

friend

friend class bdiGeometryMultilineData

friend

Member Data Documentation

diguyAuthorVisualMultilineCreateFunc* diguyAuthorVisualMultiline::s_create_func

static

bdiGeometryMultilineData* diguyAuthorVisualMultiline::m_scripted_object

protected

diguyAuthorVisualMaterial* diguyAuthorVisualMultiline::m_visual_material

protected

long diguyAuthorVisualMultiline::m_uid

protected

---

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

• E:/nightly/2532/include/diguyAuthorVisualMultiline.h