diguyAuthorVisualMaterial Class Reference

Summary: More...

#include <diguyAuthorVisualMaterial.h>

Public Member Functions
const char *	get_name ()
	Returns the name of this material. More...
Polygon Material Functions
diguyVec4f	get_brush_color ()
	Returns the material's primary brush color. More...
int	get_num_layers ()
	Returns the suggested number of "layers", or vertical divisions, that should be used to construct polygonal solids such as spheres, cones, cylinders, and other shapes that need linear approximations of circular data. More...
int	get_num_slices ()
	Returns the suggested number of "slices", or radial divisions, that should be used to construct polygonal solids such as spheres, cones, cylinders, and other shapes that need linear approximations of circular data. More...
int	get_fill_faces ()
	Returns 1 if faces in should be visible, 0 if not. More...
Edge / Line Segment Material Functions
diguyVec4f	get_pen_color ()
	Returns the material's primary pen color. More...
diguyVec4f	get_pen2_color ()
	Returns the material's secondary pen color. More...
float	get_line_width ()
	Returns the recommended width of line segments. More...
int	get_edge_faces ()
	Returns 1 if edge line segments should be visible, 0 if not. More...

Private Functions
The functions and variables past this point are for internal use only. No external access to them is expected or necessary.
bdiGeometryVisualMaterial *	m_scripted_object
class	bdiGeometryVisualMaterial
class	bdiGeometryFactory
bdiGeometryVisualMaterial *	get_scripted_object ()
	diguyAuthorVisualMaterial (void *internal_data)

Detailed Description

Summary:

The diguyAuthorVisualMaterial class provides data needed to render DI-Guy Author visuals in a Host IG.

Constructor & Destructor Documentation

diguyAuthorVisualMaterial::diguyAuthorVisualMaterial ( void *  internal_data )

protected

Member Function Documentation

const char* diguyAuthorVisualMaterial::get_name

(

)

Returns the name of this material.

diguyVec4f diguyAuthorVisualMaterial::get_brush_color

(

)

Returns the material's primary brush color.

The brush color is used to fill the polygons of visuals. The returned vector is an RGBA color vector, with color channel values between 0 and 1.

int diguyAuthorVisualMaterial::get_num_layers

(

)

Returns the suggested number of "layers", or vertical divisions, that should be used to construct polygonal solids such as spheres, cones, cylinders, and other shapes that need linear approximations of circular data.

Analogous to layers in a round cake.

int diguyAuthorVisualMaterial::get_num_slices

(

)

Returns the suggested number of "slices", or radial divisions, that should be used to construct polygonal solids such as spheres, cones, cylinders, and other shapes that need linear approximations of circular data.

Analogous to slices in a round cake.

int diguyAuthorVisualMaterial::get_fill_faces

(

)

Returns 1 if faces in should be visible, 0 if not.

This is the same as checking whether the brush color alpha component equals 0 (complete transparency).

Shortcut for checking brush alpha not equal to 0.

diguyVec4f diguyAuthorVisualMaterial::get_pen_color

(

)

Returns the material's primary pen color.

The pen color is used for line segments and edges of visuals. The returned vector is an RGBA color vector, with color channel values between 0 and 1.

diguyVec4f diguyAuthorVisualMaterial::get_pen2_color

(

)

Returns the material's secondary pen color.

The secondary pen isn't used by a visual unless the visual's documentation explicitly says it is.

float diguyAuthorVisualMaterial::get_line_width

(

)

Returns the recommended width of line segments.

int diguyAuthorVisualMaterial::get_edge_faces

(

)

Returns 1 if edge line segments should be visible, 0 if not.

This is the same as checking whether the pen color alpha component equals 0 (complete transparency).

bdiGeometryVisualMaterial* diguyAuthorVisualMaterial::get_scripted_object ( )

inline

Friends And Related Function Documentation

friend class bdiGeometryVisualMaterial

friend

friend class bdiGeometryFactory

friend

Member Data Documentation

bdiGeometryVisualMaterial* diguyAuthorVisualMaterial::m_scripted_object

protected

---

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

• e:/Jenkins/workspace/diguy_apps_TOT_vc14_x64/include/diguyAuthorVisualMaterial.h