diguyViewCameraSettings Class Declaration

diguyViewCameraSettings.h

DI-Guy API Version 5.1.26

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

Alphabetical Index

Includes: diguy_constants.h | declspec_diguy.h

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_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);
    float get_orientation_yaw();
    float get_orientation_roll();
    float get_orientation_pitch();
    void set_distance(float distance);
    float get_distance();
    void set_fix(float x, float y, float z);
    void set_orientation_roll(float r);
    float get_fix_x();
    float get_fix_y();
    float get_fix_z();
    void set_track_name(const char* track_name);
    const char* get_track_name();
    void set_dolly_name(const char* dolly_name);
    const char* get_dolly_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_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();
    diguyViewCameraMoveMode get_move_mode();
    int set_move_mode(diguyViewCameraMoveMode move_mode);
    diguyViewCameraProjectionMode get_projection_mode();
    int set_projection_mode(diguyViewCameraProjectionMode projection_mode);
    float get_speed();
    int set_speed(float speed);
    void set_dolly_link_name(const char* dolly_link_name);
    const char* get_dolly_link_name();
    bdiCamera* get_scripted_object() {return m_camera;}
};

function diguyViewCameraSettings::get_name

Prototype:

const char* get_name();
Description:

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

C++, Perl

Returns:

name of the object

function diguyViewCameraSettings::get_type_name

Prototype:

const char* get_type_name();
Description:

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

Returns:

type name of the object

Callable From:

function diguyViewCameraSettings::set_near_plane

Prototype:

void set_near_plane(float near_plane);
Description:

This sets the distance from the camera to the near plane.

Arguments:

near_planedistance to near plane, in meters

function diguyViewCameraSettings::get_near_plane

Prototype:

float get_near_plane();
Returns:

distance from the camera to the near plane, in meters

function diguyViewCameraSettings::set_far_plane

Prototype:

void set_far_plane(float far_plane);
Description:

This sets the distance from the camera to the far plane.

Arguments:

far_planedistance to far plane, in meters

function diguyViewCameraSettings::get_far_plane

Prototype:

float get_far_plane();
Returns:

distance from the camera to the far plane, in meters

function diguyViewCameraSettings::set_fov

Prototype:

void set_fov(float fov);
Description:

This sets the field-of-view of the current camera.

Arguments:

fovfield-of-view, in degrees

function diguyViewCameraSettings::get_fov

Prototype:

float get_fov();
Returns:

field-of-view of the camera, in degrees

function diguyViewCameraSettings::set_aspect

Prototype:

void set_aspect(float aspect);
Description:

This function sets the aspect ratio of the camera.

function diguyViewCameraSettings::get_aspect

Prototype:

float get_aspect();
Returns:

aspect ratio of the camera

function diguyViewCameraSettings::set_position

Prototype:

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

This function sets the position of the camera.

Arguments:

xx position, in meters
yy position, in meters
zz position, in meters

function diguyViewCameraSettings::get_position_x

Prototype:

float get_position_x();
Returns:

position in x, in meters

function diguyViewCameraSettings::get_position_y

Prototype:

float get_position_y();
Returns:

position in y, in meters

function diguyViewCameraSettings::get_position_z

Prototype:

float get_position_z();
Returns:

position in z, in meters

function diguyViewCameraSettings::set_orientation

Prototype:

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

This function sets the orientation of the camera. Note that this affects the fix.

Arguments:

yaw rotation about z axis, in degrees
roll rotation about x axis, in degrees
pitchrotation about y axis, in degrees

function diguyViewCameraSettings::get_orientation_yaw

Prototype:

float get_orientation_yaw();
Returns:

rotation about z axis, in degrees

function diguyViewCameraSettings::get_orientation_roll

Prototype:

float get_orientation_roll();
Returns:

rotation about x axis, in degrees

function diguyViewCameraSettings::get_orientation_pitch

Prototype:

float get_orientation_pitch();
Returns:

rotation about y axis, in degrees

function diguyViewCameraSettings::set_distance

Prototype:

void set_distance(float distance);
Description:

This function sets the distance from the position to the fix point. Note that this affects the fix.

Arguments:

distancedistance in meters

function diguyViewCameraSettings::get_distance

Prototype:

float get_distance();
Returns:

distance from position to fix point, in meters

function diguyViewCameraSettings::set_fix

Prototype:

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

This function sets the fix point of the camera. Note that this affects the orientation.

Arguments:

xx position, in meters
yy position, in meters
zz position, in meters

function diguyViewCameraSettings::set_orientation_roll

Prototype:

void set_orientation_roll(float r);
Description:

This function sets the roll of the camera.

Arguments:

rrotation about x axis, in radians

function diguyViewCameraSettings::get_fix_x

Prototype:

float get_fix_x();
Returns:

fix point in x, in meters

function diguyViewCameraSettings::get_fix_y

Prototype:

float get_fix_y();
Returns:

fix point in y, in meters

function diguyViewCameraSettings::get_fix_z

Prototype:

float get_fix_z();
Returns:

fix point in z, in meters

function diguyViewCameraSettings::set_track_name

Prototype:

void set_track_name(const char* track_name);
Description:

This function sets the name of the entity the camera should look at, if such an entity can be found. This will cause fix values to change over time.

Arguments:

track_namename of entity to look at, or NULL if no entity is to be tracked

function diguyViewCameraSettings::get_track_name

Prototype:

const char* get_track_name();
Returns:

name of entity to be looked at; see set_track_name()

function diguyViewCameraSettings::set_dolly_name

Prototype:

void set_dolly_name(const char* dolly_name);
Description:

This function sets the name of the entity the camera should look from, if such an entity can be found. This will cause position values to change over time.

Arguments:

dolly_namename of entity to look from, or NULL if no entity is to influence camera position

function diguyViewCameraSettings::get_dolly_name

Prototype:

const char* get_dolly_name();
Returns:

name of entity to be looked from; see set_dolly_name()

function diguyViewCameraSettings::set_track_link_name

Prototype:

void set_track_link_name(const char* track_link_name);
Description:

This function sets the name of the link to be tracked on the entity specified by set_track_name().

Arguments:

track_link_namename of link to look at, or NULL if the base link is to be tracked

function diguyViewCameraSettings::get_track_link_name

Prototype:

const char* get_track_link_name();
Returns:

name of link to be looked at; see set_track_link_name()

function diguyViewCameraSettings::set_track_offset

Prototype:

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

function diguyViewCameraSettings::get_track_offset_x

Prototype:

float get_track_offset_x();

function diguyViewCameraSettings::get_track_offset_y

Prototype:

float get_track_offset_y();

function diguyViewCameraSettings::get_track_offset_z

Prototype:

float get_track_offset_z();

function diguyViewCameraSettings::set_track_offset_is_in_world_coordinates

Prototype:

void set_track_offset_is_in_world_coordinates(int value);

function diguyViewCameraSettings::get_track_offset_is_in_world_coordinates

Prototype:

int get_track_offset_is_in_world_coordinates();

function diguyViewCameraSettings::set_dolly_offset

Prototype:

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

function diguyViewCameraSettings::get_dolly_offset_x

Prototype:

float get_dolly_offset_x();

function diguyViewCameraSettings::get_dolly_offset_y

Prototype:

float get_dolly_offset_y();

function diguyViewCameraSettings::get_dolly_offset_z

Prototype:

float get_dolly_offset_z();

function diguyViewCameraSettings::set_dolly_offset_is_in_world_coordinates

Prototype:

void set_dolly_offset_is_in_world_coordinates(int value);

function diguyViewCameraSettings::get_dolly_offset_is_in_world_coordinates

Prototype:

int get_dolly_offset_is_in_world_coordinates();

function diguyViewCameraSettings::get_move_mode

Prototype:

diguyViewCameraMoveMode get_move_mode();

function diguyViewCameraSettings::set_move_mode

Prototype:

int set_move_mode(diguyViewCameraMoveMode move_mode);

function diguyViewCameraSettings::get_projection_mode

Prototype:

diguyViewCameraProjectionMode get_projection_mode();

function diguyViewCameraSettings::set_projection_mode

Prototype:

int set_projection_mode(diguyViewCameraProjectionMode projection_mode);

function diguyViewCameraSettings::get_speed

Prototype:

float get_speed();

function diguyViewCameraSettings::set_speed

Prototype:

int set_speed(float speed);

function diguyViewCameraSettings::set_dolly_link_name

Prototype:

void set_dolly_link_name(const char* dolly_link_name);
Description:

This function sets the name of the link to be dollied on the entity specified by set_dolly_name().

Arguments:

dolly_link_namename of link to look from, or NULL if the base link is to influence camera position

function diguyViewCameraSettings::get_dolly_link_name

Prototype:

const char* get_dolly_link_name();
Returns:

name of link to be looked from; see set_dolly_link_name()

function diguyViewCameraSettings::get_scripted_object

Prototype:

bdiCamera* get_scripted_object();

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.