diguyAuthorVisualMultiline

Generated from diguyAuthorVisualMultiline.h

DI-Guy API Version 12.5.1

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

Includes: declspec_diguy.h | diguy_vector_classes.h

Contents:

Virtual Functions

Alphabetical Index

Link against: libdiguy

Summary:

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.

class diguyAuthorVisualMultiline

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

class BDI_DECLSPEC_diguy diguyAuthorVisualMultiline
{
public:
    diguyAuthorVisualMaterial* get_visual_material();
    int  get_num_points();
    diguyVec3f get_point_position(int point_number);
    diguyVec3d get_point_position_double(int point_number);
    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();

function diguyAuthorVisualMultiline::get_visual_material

Prototype:
diguyAuthorVisualMaterial* 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.

function diguyAuthorVisualMultiline::get_num_points

Prototype:

int  get_num_points();

function diguyAuthorVisualMultiline::get_point_position

Prototype:

diguyVec3f get_point_position(int point_number);

function diguyAuthorVisualMultiline::get_point_position_double

Prototype:

diguyVec3d get_point_position_double(int point_number);

function diguyAuthorVisualMultiline::get_uid

Prototype:
long get_uid();
Returns the uid (unique identifier) of this multiline.

function diguyAuthorVisualMultiline::get_visible

Prototype:
int get_visible();
Returns 1 if this visual should be visible, else 0.

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.

function diguyAuthorVisualMultiline::build

Prototype:
virtual void build();
Description:

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

Multilines are mostly represented by renderer line primitives.

function diguyAuthorVisualMultiline::unbuild

Prototype:
virtual void unbuild();
Description:

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

function diguyAuthorVisualMultiline::update

Prototype:
virtual void update(int update_flags);
Description:

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.

function diguyAuthorVisualMultiline::draw

Prototype:
virtual void draw();
Description:

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

function diguyAuthorVisualMultiline::show

Prototype:
virtual void show();
Description:

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

function diguyAuthorVisualMultiline::hide

Prototype:
virtual void hide();
Description:

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

Alphabetical Index

These coded instructions, statements, and computer programs contain unpublished proprietary information of Boston Dynamics and are protected by Copyright Laws of the United States. They may not be used, duplicated, or disclosed in any form, in whole or in part, without the prior written consent from Boston Dynamics.

RESTRICTED RIGHTS LEGEND

Use, duplication, or disclosure by the government is subject to restrictions as set forth in FAR 52.227.19(c)(2) or subparagraph (c)(1)(ii) of the Rights in Technical Data and Computer Sofware clause at DFARS 252.227-7013 and/or in similar or successor clauses in the FAR, or the DOD or NASA FAR Supplement, or to subparagraphs (c)(1) and (c)(2) of the Commercial Computer Software--Restricted Rights at 48 CFR 52.227-19, as applicable. Unpublished-rights reserved under the Copyright Laws of the United States.

Contractor/Manufacturer is:

Boston Dynamics/78 Fourth Avenue/Waltham MA 02451.