
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
Includes: diguy_constants.h | declspec_diguy.h
class diguyViewCameraSettings
|
function diguyViewCameraSettings::get_name |
Prototype:
Description:const char* get_name();
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:
Description:const char* get_type_name();
Returns the type name of the object. This pointer will never be NULL.Returns:
type name of the objectCallable From:
- C++
- Script
function diguyViewCameraSettings::set_near_plane |
Prototype:
Description:void set_near_plane(float near_plane);
This sets the distance from the camera to the near plane.Arguments:
near_plane distance to near plane, in meters
function diguyViewCameraSettings::get_near_plane |
Prototype:
Returns:float get_near_plane();
distance from the camera to the near plane, in meters
function diguyViewCameraSettings::set_far_plane |
Prototype:
Description:void set_far_plane(float far_plane);
This sets the distance from the camera to the far plane.Arguments:
far_plane distance to far plane, in meters
function diguyViewCameraSettings::get_far_plane |
Prototype:
Returns:float get_far_plane();
distance from the camera to the far plane, in meters
function diguyViewCameraSettings::set_fov |
Prototype:
Description:void set_fov(float fov);
This sets the field-of-view of the current camera.Arguments:
fov field-of-view, in degrees
function diguyViewCameraSettings::get_fov |
Prototype:
Returns:float get_fov();
field-of-view of the camera, in degrees
function diguyViewCameraSettings::set_aspect |
Prototype:
Description:void set_aspect(float aspect);
This function sets the aspect ratio of the camera.
function diguyViewCameraSettings::get_aspect |
Prototype:
Returns:float get_aspect();
aspect ratio of the camera
function diguyViewCameraSettings::set_position |
Prototype:
Description:void set_position(float x, float y, float z);
This function sets the position of the camera.Arguments:
x x position, in meters y y position, in meters z z position, in meters
function diguyViewCameraSettings::get_position_x |
Prototype:
Returns:float get_position_x();
position in x, in meters
function diguyViewCameraSettings::get_position_y |
Prototype:
Returns:float get_position_y();
position in y, in meters
function diguyViewCameraSettings::get_position_z |
Prototype:
Returns:float get_position_z();
position in z, in meters
function diguyViewCameraSettings::set_orientation |
Prototype:
Description:void set_orientation(float yaw, float roll, float pitch);
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 pitch rotation about y axis, in degrees
function diguyViewCameraSettings::get_orientation_yaw |
Prototype:
Returns:float get_orientation_yaw();
rotation about z axis, in degrees
function diguyViewCameraSettings::get_orientation_roll |
Prototype:
Returns:float get_orientation_roll();
rotation about x axis, in degrees
function diguyViewCameraSettings::get_orientation_pitch |
Prototype:
Returns:float get_orientation_pitch();
rotation about y axis, in degrees
function diguyViewCameraSettings::set_distance |
Prototype:
Description:void set_distance(float distance);
This function sets the distance from the position to the fix point. Note that this affects the fix.Arguments:
distance distance in meters
function diguyViewCameraSettings::get_distance |
Prototype:
Returns:float get_distance();
distance from position to fix point, in meters
function diguyViewCameraSettings::set_fix |
Prototype:
Description:void set_fix(float x, float y, float z);
This function sets the fix point of the camera. Note that this affects the orientation.Arguments:
x x position, in meters y y position, in meters z z position, in meters
function diguyViewCameraSettings::set_orientation_roll |
Prototype:
Description:void set_orientation_roll(float r);
This function sets the roll of the camera.Arguments:
r rotation about x axis, in radians
function diguyViewCameraSettings::get_fix_x |
Prototype:
Returns:float get_fix_x();
fix point in x, in meters
function diguyViewCameraSettings::get_fix_y |
Prototype:
Returns:float get_fix_y();
fix point in y, in meters
function diguyViewCameraSettings::get_fix_z |
Prototype:
Returns:float get_fix_z();
fix point in z, in meters
function diguyViewCameraSettings::set_track_name |
Prototype:
Description:void set_track_name(const char* track_name);
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_name name of entity to look at, or NULL if no entity is to be tracked
function diguyViewCameraSettings::get_track_name |
Prototype:
Returns:const char* get_track_name();
name of entity to be looked at; see set_track_name()
function diguyViewCameraSettings::set_dolly_name |
Prototype:
Description:void set_dolly_name(const char* dolly_name);
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_name name of entity to look from, or NULL if no entity is to influence camera position
function diguyViewCameraSettings::get_dolly_name |
Prototype:
Returns:const char* get_dolly_name();
name of entity to be looked from; see set_dolly_name()
function diguyViewCameraSettings::set_track_link_name |
Prototype:
Description:void set_track_link_name(const char* track_link_name);
This function sets the name of the link to be tracked on the entity specified by set_track_name().Arguments:
track_link_name name of link to look at, or NULL if the base link is to be tracked
function diguyViewCameraSettings::get_track_link_name |
Prototype:
Returns:const char* get_track_link_name();
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:
Description:void set_dolly_link_name(const char* dolly_link_name);
This function sets the name of the link to be dollied on the entity specified by set_dolly_name().Arguments:
dolly_link_name name of link to look from, or NULL if the base link is to influence camera position
function diguyViewCameraSettings::get_dolly_link_name |
Prototype:
Returns:const char* get_dolly_link_name();
name of link to be looked from; see set_dolly_link_name()
function diguyViewCameraSettings::get_scripted_object |
Prototype:
bdiCamera* get_scripted_object();
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.