diguyVehicleController

Generated from diguyVehicleController.h

DI-Guy API Version 12.5.1

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

Includes: declspec_diguy.h | diguy_constants.h

Contents:

Alphabetical Index

class diguyVehicleController

class BDI_DECLSPEC_diguy diguyVehicleController
{
public:
    diguyCharacter* get_vehicle_character();
    void set_speed(float speed,
        diguySpeedUnits units = DIGUY_SPEED_UNITS_METERS_PER_SECOND);
    float get_speed(diguySpeedUnits units = DIGUY_SPEED_UNITS_METERS_PER_SECOND);
    void set_desired_speed_with_acceleration(float desired_speed,
        float acceleration,
        diguySpeedUnits units = DIGUY_SPEED_UNITS_METERS_PER_SECOND);
    void set_desired_speed_with_acceleration_time(float desired_speed,
        float acceleration_time,   // seconds
        diguySpeedUnits units = DIGUY_SPEED_UNITS_METERS_PER_SECOND);
    float get_desired_speed(diguySpeedUnits units = DIGUY_SPEED_UNITS_METERS_PER_SECOND);
    void  set_default_acceleration(float acceleration,
        diguySpeedUnits units = DIGUY_SPEED_UNITS_METERS_PER_SECOND);
    float get_default_acceleration(diguySpeedUnits units = DIGUY_SPEED_UNITS_METERS_PER_SECOND);
    void  set_default_deceleration(float deceleration,
        diguySpeedUnits units = DIGUY_SPEED_UNITS_METERS_PER_SECOND);
    float get_default_deceleration(diguySpeedUnits units = DIGUY_SPEED_UNITS_METERS_PER_SECOND);
    void set_vehicle_simulation_mode(diguyVehicleSimulationMode vsim_mode);
    diguyVehicleSimulationMode get_vehicle_simulation_mode();
    void set_front_wheels_steer_angle(float angle);
    float get_front_wheels_steer_angle();
    void set_desired_front_wheels_steer_angle(float desired_angle,
        float angle_change_rate = DIGUY_DEFAULT_FLOAT);
    float get_desired_front_wheels_steer_angle();

Character Functions

function diguyVehicleController::get_vehicle_character

Prototype:

diguyCharacter* get_vehicle_character();

Speed Functions

These functions should only be used in free action mode.

function diguyVehicleController::set_speed

Prototype:
void set_speed(float speed,
    diguySpeedUnits units = DIGUY_SPEED_UNITS_METERS_PER_SECOND);
Description:

This function sets the vehicle's speed. The speed becomes effective immediately; no acceleration or deceleration is applied.
Arguments:

speed new speed of vehicle
units units of speed
Callable From:

C++
Script

function diguyVehicleController::get_speed

Prototype:

float get_speed(diguySpeedUnits units = DIGUY_SPEED_UNITS_METERS_PER_SECOND);

function diguyVehicleController::set_desired_speed_with_acceleration

Prototype:

void set_desired_speed_with_acceleration(float desired_speed,
    float acceleration,
    diguySpeedUnits units = DIGUY_SPEED_UNITS_METERS_PER_SECOND);

function diguyVehicleController::set_desired_speed_with_acceleration_time

Prototype:

void set_desired_speed_with_acceleration_time(float desired_speed,
    float acceleration_time,   // seconds
    diguySpeedUnits units = DIGUY_SPEED_UNITS_METERS_PER_SECOND);

function diguyVehicleController::get_desired_speed

Prototype:

float get_desired_speed(diguySpeedUnits units = DIGUY_SPEED_UNITS_METERS_PER_SECOND);

function diguyVehicleController::set_default_acceleration

Prototype:

void  set_default_acceleration(float acceleration,
    diguySpeedUnits units = DIGUY_SPEED_UNITS_METERS_PER_SECOND);

function diguyVehicleController::get_default_acceleration

Prototype:

float get_default_acceleration(diguySpeedUnits units = DIGUY_SPEED_UNITS_METERS_PER_SECOND);

function diguyVehicleController::set_default_deceleration

Prototype:

void  set_default_deceleration(float deceleration,
    diguySpeedUnits units = DIGUY_SPEED_UNITS_METERS_PER_SECOND);

function diguyVehicleController::get_default_deceleration

Prototype:

float get_default_deceleration(diguySpeedUnits units = DIGUY_SPEED_UNITS_METERS_PER_SECOND);

Steering Functions

These functions should only be used in free action mode.

function diguyVehicleController::set_vehicle_simulation_mode

Prototype:

void set_vehicle_simulation_mode(diguyVehicleSimulationMode vsim_mode);

function diguyVehicleController::get_vehicle_simulation_mode

Prototype:

diguyVehicleSimulationMode get_vehicle_simulation_mode();

function diguyVehicleController::set_front_wheels_steer_angle

Prototype:

void set_front_wheels_steer_angle(float angle);

function diguyVehicleController::get_front_wheels_steer_angle

Prototype:

float get_front_wheels_steer_angle();

function diguyVehicleController::set_desired_front_wheels_steer_angle

Prototype:

void set_desired_front_wheels_steer_angle(float desired_angle,
    float angle_change_rate = DIGUY_DEFAULT_FLOAT);

function diguyVehicleController::get_desired_front_wheels_steer_angle

Prototype:

float get_desired_front_wheels_steer_angle();

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.