diguyPathShape Class Declaration

diguyPathShape.h

DI-Guy API Version 5.1.26

This file was automatically generated from comments in the C/C++ header file diguyPathShape.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 diguyPathShape

class BDI_DECLSPEC_diguy diguyPathShape
{
public:
    const char* get_name();
    int add_waypoint(diguyWaypoint* waypoint);
    int set_clamp_at_end_flag(int value);
    int get_clamp_at_end_flag();
    float get_length();
    int get_point_at_distance(float distance_into_path_shape,
        float* x, float* y, float* z,
        float* rz, float *rx, float* ry);
};

function diguyPathShape::get_name

Prototype:

const char* get_name();
Description:

Returns the name of the path shape. This pointer will never be NULL.

Callable From:

Returns:

name of the path shape

function diguyPathShape::add_waypoint

Prototype:

int add_waypoint(diguyWaypoint* waypoint);
Description:

This function adds a waypoint to the path shape.

The waypoint should be created using the diguyScenario member function create_waypoint(), and deleted using the diguyScenario member function destroy_waypoint().

An internal copy of the waypoint is made.

The same waypoint can be used for multiple path shapes.

Callable From:

API Level 2

Arguments:

waypointwaypoint to be appended to end of path
Returns:

0 on success, -1 on failure

function diguyPathShape::set_clamp_at_end_flag

Prototype:

int set_clamp_at_end_flag(int value);
Description:

This function determines what happens to objects following this path when they reach the end.

If 1, the object is restricted to stay at the end of the path.

If 0, the object will wrap to the beginning of the path.

Callable From:

API Level 2

Arguments:

value1 to clamp, 0 to wrap
Returns:

0 on success, -1 on failure

function diguyPathShape::get_clamp_at_end_flag

Prototype:

int get_clamp_at_end_flag();
Returns:

most recent setting of set_clamp_at_end_flag().

Experimental Functions

The following functions are experimental and may change or disappear with no warning.

function diguyPathShape::get_length

Prototype:

float get_length();

function diguyPathShape::get_point_at_distance

Prototype:

int get_point_at_distance(float distance_into_path_shape,
		float* x, float* y, float* z,
		float* rz, float *rx, float* ry);

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.