diguyAuthorVisualMaterial

Generated from diguyAuthorVisualMaterial.h

DI-Guy API Version 12.5.1

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

Includes: declspec_diguy.h | diguy_vector_classes.h

Contents:

Alphabetical Index

Summary:

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

class diguyAuthorVisualMaterial

class BDI_DECLSPEC_diguy diguyAuthorVisualMaterial
{
public:
    const char* get_name();
    diguyVec4f get_brush_color();
    int get_num_layers();  // number "vertical" divisions
    int get_num_slices();
    int get_fill_faces();
    diguyVec4f get_pen_color();
    diguyVec4f get_pen2_color();
    float get_line_width();
    int get_edge_faces();

function diguyAuthorVisualMaterial::get_name

Prototype:
const char* get_name();
Returns the name of this material.

Polygon Material Functions

function diguyAuthorVisualMaterial::get_brush_color

Prototype:
diguyVec4f 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.

function diguyAuthorVisualMaterial::get_num_layers

Prototype:
int get_num_layers();  // number "vertical" divisions
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.

function diguyAuthorVisualMaterial::get_num_slices

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

Analogous to slices in a round cake.

function diguyAuthorVisualMaterial::get_fill_faces

Prototype:
int 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.

Edge / Line Segment Material Functions

function diguyAuthorVisualMaterial::get_pen_color

Prototype:
diguyVec4f 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.

function diguyAuthorVisualMaterial::get_pen2_color

Prototype:
diguyVec4f 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.

function diguyAuthorVisualMaterial::get_line_width

Prototype:
float get_line_width();
Returns the recommended width of line segments.

function diguyAuthorVisualMaterial::get_edge_faces

Prototype:
int 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).

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.