DI-Guy API Version 12.5.1

This file was automatically generated from diguyAuthorVisualObjectHandle.h. Do not edit this file directly; the changes will be lost.

Contents:

• Virtual Functions

Link against: libdiguy

Summary:

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

Object handle visuals are used for simple visuals such as beads on character paths, selection handles, etc.

Function for setting the create function for object handle visual subclass objects. This should be called after diguy_author_initialize(), but before any scenario is created of loaded.

class BDI_DECLSPEC_diguy diguyAuthorVisualObjectHandle { public:     diguyAuthorVisualMaterial* get_visual_material();     enum {         HANDLE_SHAPE_CYLINDER = 0,         HANDLE_SHAPE_CONE,         HANDLE_SHAPE_SPHERE,         HANDLE_SHAPE_PATH_BEAD,         HANDLE_SHAPE_PATH_STOP_SIGN     };     int get_handle_shape() {return m_handle_shape;}     float get_radius();     float get_height();     float get_bead_depth();     float get_bead_arm_thickness();     int get_inverted();     diguyVec3f get_position();     diguyVec3d get_position_double();     diguyVec3f get_orientation();     long get_uid();     int get_visible();     virtual void build();     virtual void unbuild();     virtual void update(int update_flags);     virtual void draw();     virtual void show();     virtual void hide();

Prototype:

diguyAuthorVisualMaterial* get_visual_material();

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

	enum {
		HANDLE_SHAPE_CYLINDER = 0,
		HANDLE_SHAPE_CONE,
		HANDLE_SHAPE_SPHERE,
		HANDLE_SHAPE_PATH_BEAD,
		HANDLE_SHAPE_PATH_STOP_SIGN
	};

The shapes the handle can have.

HANDLE_SHAPE_CYLINDER

A cylinder oriented along the Z axis, with its base at the origin.

HANDLE_SHAPE_CONE

A cone oriented along the Z axis, with its base at the origin. If get_inverted() returns 1, the point will be at the origin.

HANDLE_SHAPE_SPHERE

A sphere, centered at the origin.

HANDLE_SHAPE_PATH_BEAD

Usually a plus sign with depth, oriented so it can rotate around the X axis.

HANDLE_SHAPE_PATH_STOP_SIGN

Usually an octagon with depth, oriented so it can rotate around the X axis.

Prototype:

int get_handle_shape();

Returns the handle shape. This will be one of the enum values above.

Prototype:

float get_radius();

Returns the handle radius, for those shapes that have one, including:

• cylinder
• cone
• sphere
• path_bead
• path_stop_sign

Prototype:

float get_height();

Returns the handle height, for those shapes that have one, including:

• cylinder
• cone

Prototype:

float get_bead_depth();

Returns the bead depth along the X axis, for those shapes that have one, including:

• path_bead
• path_stop_sign

Returns the bead thickness, for those shapes that have one, including:

• path_bead

Prototype:

float get_bead_arm_thickness();

Prototype:

int get_inverted();

Returns whether the handle shape should be inverted. Valid for:

• cone

Prototype:

diguyVec3f get_position();

Returns the position, in meters from the origin, of the object handle in the Boston Dynamics global coordinate system. See diguyCharacter::set_position() for a description of the coordinate system.

Prototype:

diguyVec3d get_position_double();

Returns the high precision position of the object handle.

Prototype:

diguyVec3f get_orientation();

Returns the orientation, in degrees, of the object handle in the Boston Dynamics global coordinate system. See diguyCharacter::set_position() for a description of the coordinate system.

Prototype:

long get_uid();

Returns the uid (unique identifier) of this object handle.

Prototype:

int get_visible();

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

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.

Prototype:

virtual void build();

Description:

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

Prototype:

virtual void unbuild();

Description:

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

Prototype:

virtual void update(int update_flags);

Description:

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

DIGUY_GRAPHICS_VISUAL_UPDATE_GEOMETRY

Object handles have different shapes based on the handle shape returned by get_handle_shape().

Prototype:

virtual void draw();

Description:

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

Prototype:

virtual void show();

Description:

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

Prototype:

virtual void hide();

Description:

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

Alphabetical Index

• build (diguyAuthorVisualObjectHandle)
• diguyAuthorVisualObjectHandle
• draw (diguyAuthorVisualObjectHandle)
• get_bead_arm_thickness (diguyAuthorVisualObjectHandle)
• get_bead_depth (diguyAuthorVisualObjectHandle)
• get_handle_shape (diguyAuthorVisualObjectHandle)
• get_height (diguyAuthorVisualObjectHandle)
• get_inverted (diguyAuthorVisualObjectHandle)
• get_orientation (diguyAuthorVisualObjectHandle)
• get_position (diguyAuthorVisualObjectHandle)
• get_position_double (diguyAuthorVisualObjectHandle)
• get_radius (diguyAuthorVisualObjectHandle)
• get_uid (diguyAuthorVisualObjectHandle)
• get_visible (diguyAuthorVisualObjectHandle)
• get_visual_material (diguyAuthorVisualObjectHandle)
• hide (diguyAuthorVisualObjectHandle)
• show (diguyAuthorVisualObjectHandle)
• unbuild (diguyAuthorVisualObjectHandle)
• update (diguyAuthorVisualObjectHandle)