diguySceneObject Class Declaration

diguySceneObject.h

DI-Guy API Version 5.1.26

This file was automatically generated from comments in the C/C++ header file diguySceneObject.h. Do not edit this file directly; the changes will be lost. Please mail suggestions or corrections to diguy@bdi.com

Alphabetical Index

Includes: declspec_diguy.h

Link against: libdiguy

class diguySceneObject

class BDI_DECLSPEC_diguy diguySceneObject
{
public:
    const char* get_name();
    const char* get_filename();
    const char* get_nodename();
    const char* get_alternate_filename();
    const char* get_fully_resolved_filename();
    int show();
    int hide();
    int set_switch_state(const char* switch_name, 
        int state);
    int get_switch_state(const char* switch_name);
    int set_dof_state(const char* dof_name, 
        float tx, float ty, float tz, 
        float rz, float rx, float ry);
    int set_dof_state_flt(const char* dof_name, 
        float tx, float ty, float tz, 
        float rx, float ry, float rz);
    int get_dof_state(const char* dof_name, 
        float* tx, float* ty, float* tz, 
        float* rz, float* rx, float* ry);
    int get_dof_state_flt(const char* dof_name, 
        float* tx, float* ty, float* tz, 
        float* rx, float* ry, float* rz);
    int add_switch_target(const char* switch_name, 
        int state,
        float t);
    int abort_all_switch_targets(const char* switch_name);
    int add_dof_target(const char* dof_name, 
        float tx, float ty, float tz, 
        float rz, float rx, float ry,
        float blend_tin, float blend_tout,
        const char* blend_function_name = 0);
    int add_dof_target_flt(const char* dof_name, 
        float tx, float ty, float tz, 
        float rx, float ry, float rz,
        float blend_tin, float blend_tout,
        const char* blend_function_name = 0);
    int abort_all_dof_targets(const char* dof_name);
#ifdef CPLUSPLUS_ONLY
    int draw_visual();
#endif
#ifdef CPLUSPLUS_ONLY
public: 
  const bdiScenarioSceneObject * get_bdiScenarioSceneObject() { return m_scene_object; }
};

function diguySceneObject::get_name

Prototype:

const char* get_name();
Description:

Returns the name of the scene object. This pointer will never be NULL.

Callable From:

Returns:

name of the scene object

function diguySceneObject::get_filename

Prototype:

const char* get_filename();
Description:

Returns the filename of the scene object. This pointer will never be NULL.

The returned filename may be relative to another directory, such as $DIGUY/geometry/sets. Call get_fully_resolved_filename() to have DI-Guy search for the fully resolved filename.

Returns:

filename of the scene object

Callable From:

function diguySceneObject::get_nodename

Prototype:

const char* get_nodename();
Returns:

node within the scene object file; returned string is 0 length if contents of entire file should be used

Callable From:

function diguySceneObject::get_alternate_filename

Prototype:

const char* get_alternate_filename();
Returns:

alternate filename of the scene object

Callable From:

function diguySceneObject::get_fully_resolved_filename

Prototype:

const char* get_fully_resolved_filename();
Description:

Returns the fully resolved filename of the scene object. Returns NULL if the file cannot be found.

Returns:

fully resolved filename of the scene object; NULL if not found

Callable From:

function diguySceneObject::show

Prototype:

int show();
Description:

Attempts to load the file returned by get_filename() and construct an object that can be rendered in the current graphics environment by the call draw_visual().

Returns:

0 on success, -1 on failure

OpenGL Version:

Function will create OpenGL display lists.

Performer 2.x Version:

Function will have no effect. User must load and display object.

Direct3D Version:

Function will have no effect. User must load and display object.

Callable From:

function diguySceneObject::hide

Prototype:

int hide();
Description:

Hides the scene object. See show() for notes on which platforms do not yet display scene objects.

Returns:

0 on success, -1 on failure

Callable From:

function diguySceneObject::set_switch_state

Prototype:

int set_switch_state(const char* switch_name, 
		int state);
Description:

Set the state of a switch belonging to this scene object. Currently only supported on OGL & Performer platforms.

Arguments:

switch_namethe name of the switch element
state the state, i.e. active sub-element, of the switch
Returns:

0 on success, -1 on failure

Callable From:

function diguySceneObject::get_switch_state

Prototype:

int get_switch_state(const char* switch_name);
Description:

Get the state of a switch belonging to this scene object. Currently only supported on OGL & Performer platforms.

Arguments:

switch_namethe name of the switch element
Returns:

The state of the switch, -1 if fails.

Callable From:

function diguySceneObject::set_dof_state

Prototype:

int set_dof_state(const char* dof_name, 
		float tx, float ty, float tz, 
		float rz, float rx, float ry);
Description:

Set the state of a DOF element belonging to this scene object. Currently only supported on OGL & Performer platforms.

Arguments:

dof_name the name of the DOF element
tx, ty, tzthe x, y, and z displacements of the DOF
rz, rx, rythe rotation of the DOF about the z-, x-, and y-axes. The DOF will be rotated in ZXY order. For rotation in XYZ order, use set_dof_state_flt().
Returns:

0 on success, -1 on failure

Callable From:

function diguySceneObject::set_dof_state_flt

Prototype:

int set_dof_state_flt(const char* dof_name, 
		float tx, float ty, float tz, 
		float rx, float ry, float rz);
Description:

Set the state of a DOF element belonging to this scene object. Currently only supported on OGL & Performer platforms.

Arguments:

dof_name the name of the DOF element
tx, ty, tzthe x, y, and z displacements of the DOF
rx, ry, rzthe rotation of the DOF about the z-, x-, and y-axes. The DOF will be rotated in XYZ order. For rotation in ZXY order, use set_dof_state().
Returns:

0 on success, -1 on failure

Callable From:

function diguySceneObject::get_dof_state

Prototype:

int get_dof_state(const char* dof_name, 
		float* tx, float* ty, float* tz, 
		float* rz, float* rx, float* ry);
Description:

Get the state of a DOF element belonging to this scene object. Currently only supported on OGL & Performer platforms.

Arguments:

dof_name the name of the DOF element
tx, ty, tzthe x, y, and z displacements of the DOF
rz, rx, rythe rotation of the DOF about the z-, x-, and y-axes. The returned values assume ZXY order. For XYZ order, use get_dof_state_flt().
Returns:

0 on success, -1 on failure

Callable From:

function diguySceneObject::get_dof_state_flt

Prototype:

int get_dof_state_flt(const char* dof_name, 
		float* tx, float* ty, float* tz, 
		float* rx, float* ry, float* rz);
Description:

Get the state of a DOF element belonging to this scene object. Currently only supported on OGL & Performer platforms.

Arguments:

dof_name the name of the DOF element
tx, ty, tzthe x, y, and z displacements of the DOF
rx, ry, rzthe rotation of the DOF about the z-, x-, and y-axes. The returned values assume XYZ order. For ZXY order, use get_dof_state().
Returns:

0 on success, -1 on failure

Callable From:

function diguySceneObject::add_switch_target

Prototype:

int add_switch_target(const char* switch_name, 
		int state,
		float t);
Description:

Set a trigger to change the state of a switch at a given time. Currently only supported on OGL & Performer platforms.

Arguments:

switch_namethe name of the switch to be triggered.
state the state the switch should be in after time t.
t the time at which the switch should switch.
Returns:

0 on success, -1 on failure

Callable From:

function diguySceneObject::abort_all_switch_targets

Prototype:

int abort_all_switch_targets(const char* switch_name);
Description:

Abort all the targets states for a given switch which have been set either using the DI-Guy function, add_dof_target() or using a behavior file. Currently only supported on OGL & Performer platforms.

Arguments:

switch_namethe name of the switch whose targets are to be aborted.
Returns:

0 on success, -1 on failure

Callable From:

function diguySceneObject::add_dof_target

Prototype:

int add_dof_target(const char* dof_name, 
		float tx, float ty, float tz, 
		float rz, float rx, float ry,
		float blend_tin, float blend_tout,
		const char* blend_function_name = 0);
Description:

Set a trigger to change the state of a DOF at a given time. Currently only supported on OGL & Performer platforms.

Arguments:

dof_name the name of the DOF element
tx, ty, tz the x, y, and z displacements of the DOF
rz, rx, ry the rotation of the DOF about the z-, x-, and y-axes. The DOF will be rotated in ZXY order. For rotation in XYZ order, use add_dof_target_flt().
tin the time at which the DOF should begin changing states.
tin the time at which the DOF should stop changing states.
blend_function_namethe type of interpolation to be used between the current and desired DOF states. Currently, valid function names are "Linear", "HalfSine", and "QuarterSine".
Returns:

0 on success, -1 on failure

Callable From:

function diguySceneObject::add_dof_target_flt

Prototype:

int add_dof_target_flt(const char* dof_name, 
		float tx, float ty, float tz, 
		float rx, float ry, float rz,
		float blend_tin, float blend_tout,
		const char* blend_function_name = 0);
Description:

Set a trigger to change the state of a DOF at a given time. Currently only supported on OGL & Performer platforms.

Arguments:

dof_name the name of the DOF element
tx, ty, tz the x, y, and z displacements of the DOF
rx, ry, rz the rotation of the DOF about the z-, x-, and y-axes. The DOF will be rotated in XYZ order. For rotation in ZXY order, use add_dof_target().
tin the time at which the DOF should begin changing states.
tin the time at which the DOF should stop changing states.
blend_function_namethe type of interpolation to be used between the current and desired DOF states. Currently, valid function names are "Linear", "HalfSine", and "QuarterSine".
Returns:

0 on success, -1 on failure

Callable From:

function diguySceneObject::abort_all_dof_targets

Prototype:

int abort_all_dof_targets(const char* dof_name);
Description:

Abort all the targets states for a given DOF which have been set either using the DI-Guy function, add_dof_target() or using a behavior file. Currently only supported on OGL & Performer platforms.

Arguments:

dof_namethe name of the DOF whose targets are to be aborted.
Returns:

0 on success, -1 on failure

Callable From:

function diguySceneObject::draw_visual

Prototype:

int draw_visual();
Description:

Draws the object created by create_visual(). See create_visual() for notes on which platforms do not yet display scene objects.

Returns:

0 on success, -1 on failure

Callable From:


Alphabetical Index


Copyright (C) 1992-2003

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/515 Massachusetts Avenue/Cambridge MA 02139.