diguyAuthorVisualRegionPaintbrush

Generated from diguyAuthorVisualRegionPaintbrush.h

DI-Guy API Version 12.5.1

This file was automatically generated from diguyAuthorVisualRegionPaintbrush.h. Do not edit this file directly; the changes will be lost.
Includes: declspec_diguy.h | diguy_constants.h

Contents:

Alphabetical Index

Link against: libdiguy

Summary:

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

Region paintbrush visuals are used to visualize the 3D paintbrush used to show where painted regions and meshes will appear.

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.

class diguyAuthorVisualRegionPaintbrush

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

class BDI_DECLSPEC_diguy diguyAuthorVisualRegionPaintbrush
{
public:
    diguyAuthorVisualMaterial* get_visual_material();
    diguyVec3f get_position();
    diguySubregionIndex get_painting_subregion();
    void set_painting_subregion(diguySubregionIndex subregion_index);
    diguyRegionPaintbrushMode get_paintrush_mode();
    void set_paintrush_mode(diguyRegionPaintbrushMode mode);
    float get_brush_size();
    void set_brush_size(float radius);
    int get_brush_is_eraser();
    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 diguyAuthorVisualRegionPaintbrush::get_visual_material

Prototype:

diguyAuthorVisualMaterial* get_visual_material();
Returns the visual material to be used for rendering this object.

function diguyAuthorVisualRegionPaintbrush::get_position

Prototype:

diguyVec3f get_position();
Returns the current position of the paintbrush in meters from the DI-Guy origin.

function diguyAuthorVisualRegionPaintbrush::get_painting_subregion

Prototype:

diguySubregionIndex get_painting_subregion();
Returns the index of the subregion the paintbrush will paint into. This will be a diguySubregionIndex enumeration value.

function diguyAuthorVisualRegionPaintbrush::set_painting_subregion

Prototype:

void set_painting_subregion(diguySubregionIndex subregion_index);
Sets the index of the subregion the paintbrush will paint into.

function diguyAuthorVisualRegionPaintbrush::get_paintrush_mode

Prototype:

diguyRegionPaintbrushMode get_paintrush_mode();
Returns the current paintbrush mode, a diguyRegionPaintbrushMode enumeration value.

function diguyAuthorVisualRegionPaintbrush::set_paintrush_mode

Prototype:

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.

function diguyAuthorVisualRegionPaintbrush::get_brush_size

Prototype:

float get_brush_size();
Returns the radius of the paintbrush.

function diguyAuthorVisualRegionPaintbrush::set_brush_size

Prototype:

void set_brush_size(float radius);
Sets the radius of the paintbrush.

function diguyAuthorVisualRegionPaintbrush::get_brush_is_eraser

Prototype:

int get_brush_is_eraser();
Returns 1 if the paintbrush should be shown as an eraser, else 0.

function diguyAuthorVisualRegionPaintbrush::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. Most visuals have a similar set of virtual functions.

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 diguyAuthorVisualRegionPaintbrush::build

Prototype:

virtual void build();
Description:

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

function diguyAuthorVisualRegionPaintbrush::unbuild

Prototype:

virtual void unbuild();
Description:

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

function diguyAuthorVisualRegionPaintbrush::update

Prototype:

virtual void update(int update_flags);
Description:

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.

function diguyAuthorVisualRegionPaintbrush::draw

Prototype:

virtual void draw();
Description:

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

function diguyAuthorVisualRegionPaintbrush::show

Prototype:

virtual void show();
Description:

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

function diguyAuthorVisualRegionPaintbrush::hide

Prototype:

virtual void hide();
Description:

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

Alphabetical Index



Copyright (C) 1992-2012 Boston Dynamics

ALL RIGHTS RESERVED.

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.