diguyViewCameraSettings

Generated from diguyViewCameraSettings.h

DI-Guy API Version 12.5.1

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

Contents:

Alphabetical Index

The diguyViewCameraSettings class holds camera settings data that can be loaded into a diguyViewCamera using the diguyViewCamera::load_settings() call.

The settings of a diguyViewCameraSettings object cannot be directly applied to a graphics environment viewpoint; the settings must be loaded into a diguyViewCamera to be applied.

The diguyViewCameraSettings API closely mirrors the diguyViewCamera API, with the exception of load, apply, and callback functions.

class diguyViewCameraSettings

class BDI_DECLSPEC_diguy diguyViewCameraSettings
{
public:
    const char* get_name();
    const char* get_type_name();
    void set_near_plane(float near_plane);
    float get_near_plane();
    void set_far_plane(float far_plane);
    float get_far_plane();
    void set_fov(float fov);
    float get_fov();
    void set_min_fov(float fov);
    void set_max_fov(float fov);
    float get_min_fov();
    float get_max_fov();
    void set_aspect(float aspect);
    float get_aspect();
    void set_position(float x, float y, float z);
    float get_position_x();
    float get_position_y();
    float get_position_z();
    void set_orientation(float yaw, float roll, float pitch);
    void set_orientation_roll(float r);
    float get_orientation_yaw();
    float get_orientation_roll();
    float get_orientation_pitch();
    void set_pitch_lower_limit(float limit);
    void set_pitch_upper_limit(float limit);
    float get_pitch_lower_limit();
    float get_pitch_upper_limit();
    int get_pitch_has_limits();
    void set_distance(float distance);
    float get_distance();
    void set_fix(float x, float y, float z);
    float get_fix_x();
    float get_fix_y();
    float get_fix_z();
    int set_move_mode(diguyViewCameraMoveMode move_mode);
    diguyViewCameraMoveMode get_move_mode();
    int set_projection_mode(diguyViewCameraProjectionMode projection_mode);
    diguyViewCameraProjectionMode get_projection_mode();
    int set_speed(float speed);
    float get_speed();
    void set_track_name(const char* track_name);
    const char* get_track_name();
    void set_track_link_name(const char* track_link_name);
    const char* get_track_link_name();
    void set_track_offset(float x, float y, float z);
    float get_track_offset_x();
    float get_track_offset_y();
    float get_track_offset_z();
    void set_track_offset_is_in_world_coordinates(int value);
    int get_track_offset_is_in_world_coordinates();
    void set_dolly_name(const char* dolly_name);
    const char* get_dolly_name();
    void set_dolly_link_name(const char* dolly_link_name);
    const char* get_dolly_link_name();
    void set_dolly_offset(float x, float y, float z);
    float get_dolly_offset_x();
    float get_dolly_offset_y();
    float get_dolly_offset_z();
    void set_dolly_offset_is_in_world_coordinates(int value);
    int get_dolly_offset_is_in_world_coordinates();
    void set_speed_fov_degrees_per_wheel_click(float fov_change);
    float get_speed_fov_degrees_per_wheel_click();
    void set_speed_meters_per_second(float speed);
    float get_speed_meters_per_second();
    void set_require_smooth_servo(int require);
    int get_require_smooth_servo();
    void set_track_camera_avoids_obstacles(int avoid);
    int get_track_camera_avoids_obstacles();
    void set_ignore_mouse_drags(int ignore);
    int get_ignore_mouse_drags();
General Functions

function diguyViewCameraSettings::get_name

Prototype:

const char* get_name();
Description:

The diguyViewCameraSettings equivalent of diguyViewCamera::get_name().

function diguyViewCameraSettings::get_type_name

Prototype:

const char* get_type_name();
Description:

The diguyViewCameraSettings equivalent of diguyViewCamera::get_type_name().

function diguyViewCameraSettings::set_near_plane

Prototype:

void set_near_plane(float near_plane);
Description:

The diguyViewCameraSettings equivalent of diguyViewCamera::set_near_plane().

function diguyViewCameraSettings::get_near_plane

Prototype:

float get_near_plane();
Description:

The diguyViewCameraSettings equivalent of diguyViewCamera::get_near_plane().

function diguyViewCameraSettings::set_far_plane

Prototype:

void set_far_plane(float far_plane);
Description:

The diguyViewCameraSettings equivalent of diguyViewCamera::set_far_plane().

function diguyViewCameraSettings::get_far_plane

Prototype:

float get_far_plane();
Description:

The diguyViewCameraSettings equivalent of diguyViewCamera::get_far_plane().

function diguyViewCameraSettings::set_fov

Prototype:

void set_fov(float fov);
Description:

The diguyViewCameraSettings equivalent of diguyViewCamera::set_fov().

function diguyViewCameraSettings::get_fov

Prototype:

float get_fov();
Description:

The diguyViewCameraSettings equivalent of diguyViewCamera::get_fov().

function diguyViewCameraSettings::set_min_fov

Prototype:

void set_min_fov(float fov);
Description:

The diguyViewCameraSettings equivalent of diguyViewCamera::set_min_fov().

function diguyViewCameraSettings::set_max_fov

Prototype:

void set_max_fov(float fov);
Description:

The diguyViewCameraSettings equivalent of diguyViewCamera::set_max_fov().

function diguyViewCameraSettings::get_min_fov

Prototype:

float get_min_fov();
Description:

The diguyViewCameraSettings equivalent of diguyViewCamera::get_min_fov().

function diguyViewCameraSettings::get_max_fov

Prototype:

float get_max_fov();
Description:

The diguyViewCameraSettings equivalent of diguyViewCamera::get_max_fov().

function diguyViewCameraSettings::set_aspect

Prototype:

void set_aspect(float aspect);
Description:

The diguyViewCameraSettings equivalent of diguyViewCamera::set_aspect().

function diguyViewCameraSettings::get_aspect

Prototype:

float get_aspect();
Description:

The diguyViewCameraSettings equivalent of diguyViewCamera::get_aspect().

function diguyViewCameraSettings::set_position

Prototype:

void set_position(float x, float y, float z);
Description:

The diguyViewCameraSettings equivalent of diguyViewCamera::set_position().

function diguyViewCameraSettings::get_position_x

Prototype:

float get_position_x();
Description:

The diguyViewCameraSettings equivalent of diguyViewCamera::get_position_x().

function diguyViewCameraSettings::get_position_y

Prototype:

float get_position_y();
Description:

The diguyViewCameraSettings equivalent of diguyViewCamera::get_position_y().

function diguyViewCameraSettings::get_position_z

Prototype:

float get_position_z();
Description:

The diguyViewCameraSettings equivalent of diguyViewCamera::get_position_z().

function diguyViewCameraSettings::set_orientation

Prototype:

void set_orientation(float yaw, float roll, float pitch);
Description:

The diguyViewCameraSettings equivalent of diguyViewCamera::set_orientation().

function diguyViewCameraSettings::set_orientation_roll

Prototype:

void set_orientation_roll(float r);
Description:

The diguyViewCameraSettings equivalent of diguyViewCamera::set_orientation_roll().

function diguyViewCameraSettings::get_orientation_yaw

Prototype:

float get_orientation_yaw();
Description:

The diguyViewCameraSettings equivalent of diguyViewCamera::get_orientation_yaw().

function diguyViewCameraSettings::get_orientation_roll

Prototype:

float get_orientation_roll();
Description:

The diguyViewCameraSettings equivalent of diguyViewCamera::get_orientation_roll().

function diguyViewCameraSettings::get_orientation_pitch

Prototype:

float get_orientation_pitch();
Description:

The diguyViewCameraSettings equivalent of diguyViewCamera::get_orientation_pitch().

function diguyViewCameraSettings::set_pitch_lower_limit

Prototype:

void set_pitch_lower_limit(float limit);
Description:

The diguyViewCameraSettings equivalent of diguyViewCamera::set_pitch_lower_limit().

function diguyViewCameraSettings::set_pitch_upper_limit

Prototype:

void set_pitch_upper_limit(float limit);
Description:

The diguyViewCameraSettings equivalent of diguyViewCamera::set_pitch_upper_limit().

function diguyViewCameraSettings::get_pitch_lower_limit

Prototype:

float get_pitch_lower_limit();
Description:

The diguyViewCameraSettings equivalent of diguyViewCamera::get_pitch_lower_limit().

function diguyViewCameraSettings::get_pitch_upper_limit

Prototype:

float get_pitch_upper_limit();
Description:

The diguyViewCameraSettings equivalent of diguyViewCamera::get_pitch_upper_limit().

function diguyViewCameraSettings::get_pitch_has_limits

Prototype:

int get_pitch_has_limits();
Description:

The diguyViewCameraSettings equivalent of diguyViewCamera::get_pitch_has_limits().

function diguyViewCameraSettings::set_distance

Prototype:

void set_distance(float distance);
Description:

The diguyViewCameraSettings equivalent of diguyViewCamera::set_distance().

function diguyViewCameraSettings::get_distance

Prototype:

float get_distance();
Description:

The diguyViewCameraSettings equivalent of diguyViewCamera::get_distance().

function diguyViewCameraSettings::set_fix

Prototype:

void set_fix(float x, float y, float z);
Description:

The diguyViewCameraSettings equivalent of diguyViewCamera::set_fix().

function diguyViewCameraSettings::get_fix_x

Prototype:

float get_fix_x();
Description:

The diguyViewCameraSettings equivalent of diguyViewCamera::get_fix_x().

function diguyViewCameraSettings::get_fix_y

Prototype:

float get_fix_y();
Description:

The diguyViewCameraSettings equivalent of diguyViewCamera::get_fix_y().

function diguyViewCameraSettings::get_fix_z

Prototype:

float get_fix_z();
Description:

The diguyViewCameraSettings equivalent of diguyViewCamera::get_fix_z().

function diguyViewCameraSettings::set_move_mode

Prototype:

int set_move_mode(diguyViewCameraMoveMode move_mode);
Description:

The diguyViewCameraSettings equivalent of diguyViewCamera::set_move_mode().

function diguyViewCameraSettings::get_move_mode

Prototype:

diguyViewCameraMoveMode get_move_mode();
Description:

The diguyViewCameraSettings equivalent of diguyViewCamera::get_move_mode().

function diguyViewCameraSettings::set_projection_mode

Prototype:

int set_projection_mode(diguyViewCameraProjectionMode projection_mode);
Description:

The diguyViewCameraSettings equivalent of diguyViewCamera::set_projection_mode().

function diguyViewCameraSettings::get_projection_mode

Prototype:

diguyViewCameraProjectionMode get_projection_mode();
Description:

The diguyViewCameraSettings equivalent of diguyViewCamera::get_projection_mode().

function diguyViewCameraSettings::set_speed

Prototype:

int set_speed(float speed);
Description:

The diguyViewCameraSettings equivalent of diguyViewCamera::set_speed().

function diguyViewCameraSettings::get_speed

Prototype:

float get_speed();
Description:

The diguyViewCameraSettings equivalent of diguyViewCamera::get_speed().

Look At and Look From Functions

function diguyViewCameraSettings::set_track_name

Prototype:

void set_track_name(const char* track_name);
Description:

The diguyViewCameraSettings equivalent of diguyViewCamera::set_track_name().

function diguyViewCameraSettings::get_track_name

Prototype:

const char* get_track_name();
Description:

The diguyViewCameraSettings equivalent of diguyViewCamera::get_track_name().

function diguyViewCameraSettings::set_track_link_name

Prototype:

void set_track_link_name(const char* track_link_name);
Description:

The diguyViewCameraSettings equivalent of diguyViewCamera::set_track_link_name().

function diguyViewCameraSettings::get_track_link_name

Prototype:

const char* get_track_link_name();
Description:

The diguyViewCameraSettings equivalent of diguyViewCamera::get_track_link_name().

function diguyViewCameraSettings::set_track_offset

Prototype:

void set_track_offset(float x, float y, float z);
Description:

The diguyViewCameraSettings equivalent of diguyViewCamera::set_track_offset().

function diguyViewCameraSettings::get_track_offset_x

Prototype:

float get_track_offset_x();
Description:

The diguyViewCameraSettings equivalent of diguyViewCamera::get_track_offset_x().

function diguyViewCameraSettings::get_track_offset_y

Prototype:

float get_track_offset_y();
Description:

The diguyViewCameraSettings equivalent of diguyViewCamera::get_track_offset_y().

function diguyViewCameraSettings::get_track_offset_z

Prototype:

float get_track_offset_z();
Description:

The diguyViewCameraSettings equivalent of diguyViewCamera::get_track_offset_z().

function diguyViewCameraSettings::set_track_offset_is_in_world_coordinates

Prototype:

void set_track_offset_is_in_world_coordinates(int value);
Description:

The diguyViewCameraSettings equivalent of diguyViewCamera::set_track_offset_is_in_world_coordinates().

function diguyViewCameraSettings::get_track_offset_is_in_world_coordinates

Prototype:

int get_track_offset_is_in_world_coordinates();
Description:

The diguyViewCameraSettings equivalent of diguyViewCamera::get_track_offset_is_in_world_coordinates().

function diguyViewCameraSettings::set_dolly_name

Prototype:

void set_dolly_name(const char* dolly_name);
Description:

The diguyViewCameraSettings equivalent of diguyViewCamera::set_dolly_name().

function diguyViewCameraSettings::get_dolly_name

Prototype:

const char* get_dolly_name();
Description:

The diguyViewCameraSettings equivalent of diguyViewCamera::get_dolly_name().

function diguyViewCameraSettings::set_dolly_link_name

Prototype:

void set_dolly_link_name(const char* dolly_link_name);
Description:

The diguyViewCameraSettings equivalent of diguyViewCamera::set_dolly_link_name().

function diguyViewCameraSettings::get_dolly_link_name

Prototype:

const char* get_dolly_link_name();
Description:

The diguyViewCameraSettings equivalent of diguyViewCamera::get_dolly_link_name().

function diguyViewCameraSettings::set_dolly_offset

Prototype:

void set_dolly_offset(float x, float y, float z);
Description:

The diguyViewCameraSettings equivalent of diguyViewCamera::set_dolly_offset().

function diguyViewCameraSettings::get_dolly_offset_x

Prototype:

float get_dolly_offset_x();
Description:

The diguyViewCameraSettings equivalent of diguyViewCamera::get_dolly_offset_x().

function diguyViewCameraSettings::get_dolly_offset_y

Prototype:

float get_dolly_offset_y();
Description:

The diguyViewCameraSettings equivalent of diguyViewCamera::get_dolly_offset_y().

function diguyViewCameraSettings::get_dolly_offset_z

Prototype:

float get_dolly_offset_z();
Description:

The diguyViewCameraSettings equivalent of diguyViewCamera::get_dolly_offset_z().

function diguyViewCameraSettings::set_dolly_offset_is_in_world_coordinates

Prototype:

void set_dolly_offset_is_in_world_coordinates(int value);
Description:

The diguyViewCameraSettings equivalent of diguyViewCamera::set_dolly_offset_is_in_world_coordinates().

function diguyViewCameraSettings::get_dolly_offset_is_in_world_coordinates

Prototype:

int get_dolly_offset_is_in_world_coordinates();
Description:

The diguyViewCameraSettings equivalent of diguyViewCamera::get_dolly_offset_is_in_world_coordinates().

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

function diguyViewCameraSettings::set_speed_fov_degrees_per_wheel_click

Prototype:

void set_speed_fov_degrees_per_wheel_click(float fov_change);
The diguyViewCameraSettings equivalent of the diguyViewCamera function with the same name.

function diguyViewCameraSettings::get_speed_fov_degrees_per_wheel_click

Prototype:

float get_speed_fov_degrees_per_wheel_click();
The diguyViewCameraSettings equivalent of the diguyViewCamera function with the same name.

function diguyViewCameraSettings::set_speed_meters_per_second

Prototype:

void set_speed_meters_per_second(float speed);
The diguyViewCameraSettings equivalent of the diguyViewCamera function with the same name.

function diguyViewCameraSettings::get_speed_meters_per_second

Prototype:

float get_speed_meters_per_second();
The diguyViewCameraSettings equivalent of the diguyViewCamera function with the same name.

function diguyViewCameraSettings::set_require_smooth_servo

Prototype:

void set_require_smooth_servo(int require);
The diguyViewCameraSettings equivalent of the diguyViewCamera function with the same name.

function diguyViewCameraSettings::get_require_smooth_servo

Prototype:

int get_require_smooth_servo();
The diguyViewCameraSettings equivalent of the diguyViewCamera function with the same name.

function diguyViewCameraSettings::set_track_camera_avoids_obstacles

Prototype:

void set_track_camera_avoids_obstacles(int avoid);
The diguyViewCameraSettings equivalent of the diguyViewCamera function with the same name.

function diguyViewCameraSettings::get_track_camera_avoids_obstacles

Prototype:

int get_track_camera_avoids_obstacles();
The diguyViewCameraSettings equivalent of the diguyViewCamera function with the same name.

function diguyViewCameraSettings::set_ignore_mouse_drags

Prototype:

void set_ignore_mouse_drags(int ignore);
The diguyViewCameraSettings equivalent of the diguyViewCamera function with the same name.

function diguyViewCameraSettings::get_ignore_mouse_drags

Prototype:

int get_ignore_mouse_drags();
The diguyViewCameraSettings equivalent of the diguyViewCamera function with the same name.

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.