diguyViewCameraSettings Class Reference

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

#include <diguyViewCameraSettings.h>

Public Member Functions
General Functions
const char *	get_name ()
	The diguyViewCameraSettings equivalent of diguyViewCamera::get_name(). More...
const char *	get_type_name ()
	The diguyViewCameraSettings equivalent of diguyViewCamera::get_type_name(). More...
void	set_near_plane (float near_plane)
	The diguyViewCameraSettings equivalent of diguyViewCamera::set_near_plane(). More...
float	get_near_plane ()
	The diguyViewCameraSettings equivalent of diguyViewCamera::get_near_plane(). More...
void	set_far_plane (float far_plane)
	The diguyViewCameraSettings equivalent of diguyViewCamera::set_far_plane(). More...
float	get_far_plane ()
	The diguyViewCameraSettings equivalent of diguyViewCamera::get_far_plane(). More...
void	set_fov (float fov)
	The diguyViewCameraSettings equivalent of diguyViewCamera::set_fov(). More...
float	get_fov ()
	The diguyViewCameraSettings equivalent of diguyViewCamera::get_fov(). More...
void	set_min_fov (float fov)
	The diguyViewCameraSettings equivalent of diguyViewCamera::set_min_fov(). More...
void	set_max_fov (float fov)
	The diguyViewCameraSettings equivalent of diguyViewCamera::set_max_fov(). More...
float	get_min_fov ()
	The diguyViewCameraSettings equivalent of diguyViewCamera::get_min_fov(). More...
float	get_max_fov ()
	The diguyViewCameraSettings equivalent of diguyViewCamera::get_max_fov(). More...
void	set_aspect (float aspect)
	The diguyViewCameraSettings equivalent of diguyViewCamera::set_aspect(). More...
float	get_aspect ()
	The diguyViewCameraSettings equivalent of diguyViewCamera::get_aspect(). More...
void	set_position (float x, float y, float z)
	The diguyViewCameraSettings equivalent of diguyViewCamera::set_position(). More...
float	get_position_x ()
	The diguyViewCameraSettings equivalent of diguyViewCamera::get_position_x(). More...
float	get_position_y ()
	The diguyViewCameraSettings equivalent of diguyViewCamera::get_position_y(). More...
float	get_position_z ()
	The diguyViewCameraSettings equivalent of diguyViewCamera::get_position_z(). More...
void	set_orientation (float yaw, float roll, float pitch)
	The diguyViewCameraSettings equivalent of diguyViewCamera::set_orientation(). More...
void	set_orientation_roll (float r)
	The diguyViewCameraSettings equivalent of diguyViewCamera::set_orientation_roll(). More...
float	get_orientation_yaw ()
	The diguyViewCameraSettings equivalent of diguyViewCamera::get_orientation_yaw(). More...
float	get_orientation_roll ()
	The diguyViewCameraSettings equivalent of diguyViewCamera::get_orientation_roll(). More...
float	get_orientation_pitch ()
	The diguyViewCameraSettings equivalent of diguyViewCamera::get_orientation_pitch(). More...
void	set_pitch_lower_limit (float limit)
	The diguyViewCameraSettings equivalent of diguyViewCamera::set_pitch_lower_limit(). More...
void	set_pitch_upper_limit (float limit)
	The diguyViewCameraSettings equivalent of diguyViewCamera::set_pitch_upper_limit(). More...
float	get_pitch_lower_limit ()
	The diguyViewCameraSettings equivalent of diguyViewCamera::get_pitch_lower_limit(). More...
float	get_pitch_upper_limit ()
	The diguyViewCameraSettings equivalent of diguyViewCamera::get_pitch_upper_limit(). More...
int	get_pitch_has_limits ()
	The diguyViewCameraSettings equivalent of diguyViewCamera::get_pitch_has_limits(). More...
void	set_distance (float distance)
	The diguyViewCameraSettings equivalent of diguyViewCamera::set_distance(). More...
float	get_distance ()
	The diguyViewCameraSettings equivalent of diguyViewCamera::get_distance(). More...
void	set_fix (float x, float y, float z)
	The diguyViewCameraSettings equivalent of diguyViewCamera::set_fix(). More...
float	get_fix_x ()
	The diguyViewCameraSettings equivalent of diguyViewCamera::get_fix_x(). More...
float	get_fix_y ()
	The diguyViewCameraSettings equivalent of diguyViewCamera::get_fix_y(). More...
float	get_fix_z ()
	The diguyViewCameraSettings equivalent of diguyViewCamera::get_fix_z(). More...
int	set_move_mode (diguyViewCameraMoveMode move_mode)
	The diguyViewCameraSettings equivalent of diguyViewCamera::set_move_mode(). More...
diguyViewCameraMoveMode	get_move_mode ()
	The diguyViewCameraSettings equivalent of diguyViewCamera::get_move_mode(). More...
int	set_projection_mode (diguyViewCameraProjectionMode projection_mode)
	The diguyViewCameraSettings equivalent of diguyViewCamera::set_projection_mode(). More...
diguyViewCameraProjectionMode	get_projection_mode ()
	The diguyViewCameraSettings equivalent of diguyViewCamera::get_projection_mode(). More...
int	set_speed (float speed)
	The diguyViewCameraSettings equivalent of diguyViewCamera::set_speed(). More...
float	get_speed ()
	The diguyViewCameraSettings equivalent of diguyViewCamera::get_speed(). More...
Look At and Look From Functions
void	set_track_name (const char *track_name)
	The diguyViewCameraSettings equivalent of diguyViewCamera::set_track_name(). More...
const char *	get_track_name ()
	The diguyViewCameraSettings equivalent of diguyViewCamera::get_track_name(). More...
void	set_track_link_name (const char *track_link_name)
	The diguyViewCameraSettings equivalent of diguyViewCamera::set_track_link_name(). More...
const char *	get_track_link_name ()
	The diguyViewCameraSettings equivalent of diguyViewCamera::get_track_link_name(). More...
void	set_track_offset (float x, float y, float z)
	The diguyViewCameraSettings equivalent of diguyViewCamera::set_track_offset(). More...
float	get_track_offset_x ()
	The diguyViewCameraSettings equivalent of diguyViewCamera::get_track_offset_x(). More...
float	get_track_offset_y ()
	The diguyViewCameraSettings equivalent of diguyViewCamera::get_track_offset_y(). More...
float	get_track_offset_z ()
	The diguyViewCameraSettings equivalent of diguyViewCamera::get_track_offset_z(). More...
void	set_track_offset_is_in_world_coordinates (int value)
	The diguyViewCameraSettings equivalent of diguyViewCamera::set_track_offset_is_in_world_coordinates(). More...
int	get_track_offset_is_in_world_coordinates ()
	The diguyViewCameraSettings equivalent of diguyViewCamera::get_track_offset_is_in_world_coordinates(). More...
void	set_dolly_name (const char *dolly_name)
	The diguyViewCameraSettings equivalent of diguyViewCamera::set_dolly_name(). More...
const char *	get_dolly_name ()
	The diguyViewCameraSettings equivalent of diguyViewCamera::get_dolly_name(). More...
void	set_dolly_link_name (const char *dolly_link_name)
	The diguyViewCameraSettings equivalent of diguyViewCamera::set_dolly_link_name(). More...
const char *	get_dolly_link_name ()
	The diguyViewCameraSettings equivalent of diguyViewCamera::get_dolly_link_name(). More...
void	set_dolly_offset (float x, float y, float z)
	The diguyViewCameraSettings equivalent of diguyViewCamera::set_dolly_offset(). More...
float	get_dolly_offset_x ()
	The diguyViewCameraSettings equivalent of diguyViewCamera::get_dolly_offset_x(). More...
float	get_dolly_offset_y ()
	The diguyViewCameraSettings equivalent of diguyViewCamera::get_dolly_offset_y(). More...
float	get_dolly_offset_z ()
	The diguyViewCameraSettings equivalent of diguyViewCamera::get_dolly_offset_z(). More...
void	set_dolly_offset_is_in_world_coordinates (int value)
	The diguyViewCameraSettings equivalent of diguyViewCamera::set_dolly_offset_is_in_world_coordinates(). More...
int	get_dolly_offset_is_in_world_coordinates ()
	The diguyViewCameraSettings equivalent of diguyViewCamera::get_dolly_offset_is_in_world_coordinates(). More...
Experimental Functions
The following functions are experimental and may change or disappear with no warning.
void	set_speed_fov_degrees_per_wheel_click (float fov_change)
	The diguyViewCameraSettings equivalent of the diguyViewCamera function with the same name. More...
float	get_speed_fov_degrees_per_wheel_click ()
	The diguyViewCameraSettings equivalent of the diguyViewCamera function with the same name. More...
void	set_speed_meters_per_second (float speed)
	The diguyViewCameraSettings equivalent of the diguyViewCamera function with the same name. More...
float	get_speed_meters_per_second ()
	The diguyViewCameraSettings equivalent of the diguyViewCamera function with the same name. More...
void	set_require_smooth_servo (diguyViewCameraServoTarget target, int require)
	The diguyViewCameraSettings equivalent of the diguyViewCamera function with the same name. More...
int	get_require_smooth_servo (diguyViewCameraServoTarget target)
	The diguyViewCameraSettings equivalent of the diguyViewCamera function with the same name. More...
void	set_track_camera_avoids_obstacles (int avoid)
	The diguyViewCameraSettings equivalent of the diguyViewCamera function with the same name. More...
int	get_track_camera_avoids_obstacles ()
	The diguyViewCameraSettings equivalent of the diguyViewCamera function with the same name. More...
void	set_ignore_mouse_drags (int ignore)
	The diguyViewCameraSettings equivalent of the diguyViewCamera function with the same name. More...
int	get_ignore_mouse_drags ()
	The diguyViewCameraSettings equivalent of the diguyViewCamera function with the same name. More...

Private Functions
The functions and variables past this point are for internal use only. No external access to them is expected or necessary.
bdiCamera *	m_camera
	A pointer to internal data. More...
class	bdiCamera
bdiCamera *	get_scripted_object ()
	diguyViewCameraSettings (bdiCamera *camera)
	A private constructor. More...

Detailed Description

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.

Constructor & Destructor Documentation

diguyViewCameraSettings::diguyViewCameraSettings ( bdiCamera *  camera )

private

A private constructor.

Member Function Documentation

const char* diguyViewCameraSettings::get_name

(

)

The diguyViewCameraSettings equivalent of diguyViewCamera::get_name().

const char* diguyViewCameraSettings::get_type_name

(

)

The diguyViewCameraSettings equivalent of diguyViewCamera::get_type_name().

void diguyViewCameraSettings::set_near_plane

(

float

near_plane

)

The diguyViewCameraSettings equivalent of diguyViewCamera::set_near_plane().

float diguyViewCameraSettings::get_near_plane

(

)

The diguyViewCameraSettings equivalent of diguyViewCamera::get_near_plane().

void diguyViewCameraSettings::set_far_plane

(

float

far_plane

)

The diguyViewCameraSettings equivalent of diguyViewCamera::set_far_plane().

float diguyViewCameraSettings::get_far_plane

(

)

The diguyViewCameraSettings equivalent of diguyViewCamera::get_far_plane().

void diguyViewCameraSettings::set_fov

(

float

fov

)

The diguyViewCameraSettings equivalent of diguyViewCamera::set_fov().

float diguyViewCameraSettings::get_fov

(

)

The diguyViewCameraSettings equivalent of diguyViewCamera::get_fov().

void diguyViewCameraSettings::set_min_fov

(

float

fov

)

The diguyViewCameraSettings equivalent of diguyViewCamera::set_min_fov().

void diguyViewCameraSettings::set_max_fov

(

float

fov

)

The diguyViewCameraSettings equivalent of diguyViewCamera::set_max_fov().

float diguyViewCameraSettings::get_min_fov

(

)

The diguyViewCameraSettings equivalent of diguyViewCamera::get_min_fov().

float diguyViewCameraSettings::get_max_fov

(

)

The diguyViewCameraSettings equivalent of diguyViewCamera::get_max_fov().

void diguyViewCameraSettings::set_aspect

(

float

aspect

)

The diguyViewCameraSettings equivalent of diguyViewCamera::set_aspect().

float diguyViewCameraSettings::get_aspect

(

)

The diguyViewCameraSettings equivalent of diguyViewCamera::get_aspect().

void diguyViewCameraSettings::set_position	(	float	x,
		float	y,
		float	z
	)

The diguyViewCameraSettings equivalent of diguyViewCamera::set_position().

float diguyViewCameraSettings::get_position_x

(

)

The diguyViewCameraSettings equivalent of diguyViewCamera::get_position_x().

float diguyViewCameraSettings::get_position_y

(

)

The diguyViewCameraSettings equivalent of diguyViewCamera::get_position_y().

float diguyViewCameraSettings::get_position_z

(

)

The diguyViewCameraSettings equivalent of diguyViewCamera::get_position_z().

void diguyViewCameraSettings::set_orientation	(	float	yaw,
		float	roll,
		float	pitch
	)

The diguyViewCameraSettings equivalent of diguyViewCamera::set_orientation().

void diguyViewCameraSettings::set_orientation_roll

(

float

r

)

The diguyViewCameraSettings equivalent of diguyViewCamera::set_orientation_roll().

float diguyViewCameraSettings::get_orientation_yaw

(

)

The diguyViewCameraSettings equivalent of diguyViewCamera::get_orientation_yaw().

float diguyViewCameraSettings::get_orientation_roll

(

)

The diguyViewCameraSettings equivalent of diguyViewCamera::get_orientation_roll().

float diguyViewCameraSettings::get_orientation_pitch

(

)

The diguyViewCameraSettings equivalent of diguyViewCamera::get_orientation_pitch().

void diguyViewCameraSettings::set_pitch_lower_limit

(

float

limit

)

The diguyViewCameraSettings equivalent of diguyViewCamera::set_pitch_lower_limit().

void diguyViewCameraSettings::set_pitch_upper_limit

(

float

limit

)

The diguyViewCameraSettings equivalent of diguyViewCamera::set_pitch_upper_limit().

float diguyViewCameraSettings::get_pitch_lower_limit

(

)

The diguyViewCameraSettings equivalent of diguyViewCamera::get_pitch_lower_limit().

float diguyViewCameraSettings::get_pitch_upper_limit

(

)

The diguyViewCameraSettings equivalent of diguyViewCamera::get_pitch_upper_limit().

int diguyViewCameraSettings::get_pitch_has_limits

(

)

The diguyViewCameraSettings equivalent of diguyViewCamera::get_pitch_has_limits().

void diguyViewCameraSettings::set_distance

(

float

distance

)

The diguyViewCameraSettings equivalent of diguyViewCamera::set_distance().

float diguyViewCameraSettings::get_distance

(

)

The diguyViewCameraSettings equivalent of diguyViewCamera::get_distance().

void diguyViewCameraSettings::set_fix	(	float	x,
		float	y,
		float	z
	)

The diguyViewCameraSettings equivalent of diguyViewCamera::set_fix().

float diguyViewCameraSettings::get_fix_x

(

)

The diguyViewCameraSettings equivalent of diguyViewCamera::get_fix_x().

float diguyViewCameraSettings::get_fix_y

(

)

The diguyViewCameraSettings equivalent of diguyViewCamera::get_fix_y().

float diguyViewCameraSettings::get_fix_z

(

)

The diguyViewCameraSettings equivalent of diguyViewCamera::get_fix_z().

int diguyViewCameraSettings::set_move_mode

(

diguyViewCameraMoveMode

move_mode

)

The diguyViewCameraSettings equivalent of diguyViewCamera::set_move_mode().

diguyViewCameraMoveMode diguyViewCameraSettings::get_move_mode

(

)

The diguyViewCameraSettings equivalent of diguyViewCamera::get_move_mode().

int diguyViewCameraSettings::set_projection_mode

(

diguyViewCameraProjectionMode

projection_mode

)

The diguyViewCameraSettings equivalent of diguyViewCamera::set_projection_mode().

diguyViewCameraProjectionMode diguyViewCameraSettings::get_projection_mode

(

)

The diguyViewCameraSettings equivalent of diguyViewCamera::get_projection_mode().

int diguyViewCameraSettings::set_speed

(

float

speed

)

The diguyViewCameraSettings equivalent of diguyViewCamera::set_speed().

float diguyViewCameraSettings::get_speed

(

)

The diguyViewCameraSettings equivalent of diguyViewCamera::get_speed().

void diguyViewCameraSettings::set_track_name

(

const char *

track_name

)

The diguyViewCameraSettings equivalent of diguyViewCamera::set_track_name().

const char* diguyViewCameraSettings::get_track_name

(

)

The diguyViewCameraSettings equivalent of diguyViewCamera::get_track_name().

void diguyViewCameraSettings::set_track_link_name

(

const char *

track_link_name

)

The diguyViewCameraSettings equivalent of diguyViewCamera::set_track_link_name().

const char* diguyViewCameraSettings::get_track_link_name

(

)

The diguyViewCameraSettings equivalent of diguyViewCamera::get_track_link_name().

void diguyViewCameraSettings::set_track_offset	(	float	x,
		float	y,
		float	z
	)

The diguyViewCameraSettings equivalent of diguyViewCamera::set_track_offset().

float diguyViewCameraSettings::get_track_offset_x

(

)

The diguyViewCameraSettings equivalent of diguyViewCamera::get_track_offset_x().

float diguyViewCameraSettings::get_track_offset_y

(

)

The diguyViewCameraSettings equivalent of diguyViewCamera::get_track_offset_y().

float diguyViewCameraSettings::get_track_offset_z

(

)

The diguyViewCameraSettings equivalent of diguyViewCamera::get_track_offset_z().

void diguyViewCameraSettings::set_track_offset_is_in_world_coordinates

(

int

value

)

The diguyViewCameraSettings equivalent of diguyViewCamera::set_track_offset_is_in_world_coordinates().

int diguyViewCameraSettings::get_track_offset_is_in_world_coordinates

(

)

The diguyViewCameraSettings equivalent of diguyViewCamera::get_track_offset_is_in_world_coordinates().

void diguyViewCameraSettings::set_dolly_name

(

const char *

dolly_name

)

The diguyViewCameraSettings equivalent of diguyViewCamera::set_dolly_name().

const char* diguyViewCameraSettings::get_dolly_name

(

)

The diguyViewCameraSettings equivalent of diguyViewCamera::get_dolly_name().

void diguyViewCameraSettings::set_dolly_link_name

(

const char *

dolly_link_name

)

The diguyViewCameraSettings equivalent of diguyViewCamera::set_dolly_link_name().

const char* diguyViewCameraSettings::get_dolly_link_name

(

)

The diguyViewCameraSettings equivalent of diguyViewCamera::get_dolly_link_name().

void diguyViewCameraSettings::set_dolly_offset	(	float	x,
		float	y,
		float	z
	)

The diguyViewCameraSettings equivalent of diguyViewCamera::set_dolly_offset().

float diguyViewCameraSettings::get_dolly_offset_x

(

)

The diguyViewCameraSettings equivalent of diguyViewCamera::get_dolly_offset_x().

float diguyViewCameraSettings::get_dolly_offset_y

(

)

The diguyViewCameraSettings equivalent of diguyViewCamera::get_dolly_offset_y().

float diguyViewCameraSettings::get_dolly_offset_z

(

)

The diguyViewCameraSettings equivalent of diguyViewCamera::get_dolly_offset_z().

void diguyViewCameraSettings::set_dolly_offset_is_in_world_coordinates

(

int

value

)

The diguyViewCameraSettings equivalent of diguyViewCamera::set_dolly_offset_is_in_world_coordinates().

int diguyViewCameraSettings::get_dolly_offset_is_in_world_coordinates

(

)

The diguyViewCameraSettings equivalent of diguyViewCamera::get_dolly_offset_is_in_world_coordinates().

void diguyViewCameraSettings::set_speed_fov_degrees_per_wheel_click

(

float

fov_change

)

The diguyViewCameraSettings equivalent of the diguyViewCamera function with the same name.

float diguyViewCameraSettings::get_speed_fov_degrees_per_wheel_click

(

)

The diguyViewCameraSettings equivalent of the diguyViewCamera function with the same name.

void diguyViewCameraSettings::set_speed_meters_per_second

(

float

speed

)

The diguyViewCameraSettings equivalent of the diguyViewCamera function with the same name.

float diguyViewCameraSettings::get_speed_meters_per_second

(

)

The diguyViewCameraSettings equivalent of the diguyViewCamera function with the same name.

void diguyViewCameraSettings::set_require_smooth_servo	(	diguyViewCameraServoTarget	target,
		int	require
	)

The diguyViewCameraSettings equivalent of the diguyViewCamera function with the same name.

int diguyViewCameraSettings::get_require_smooth_servo

(

diguyViewCameraServoTarget

target

)

The diguyViewCameraSettings equivalent of the diguyViewCamera function with the same name.

void diguyViewCameraSettings::set_track_camera_avoids_obstacles

(

int

avoid

)

The diguyViewCameraSettings equivalent of the diguyViewCamera function with the same name.

int diguyViewCameraSettings::get_track_camera_avoids_obstacles

(

)

The diguyViewCameraSettings equivalent of the diguyViewCamera function with the same name.

void diguyViewCameraSettings::set_ignore_mouse_drags

(

int

ignore

)

The diguyViewCameraSettings equivalent of the diguyViewCamera function with the same name.

int diguyViewCameraSettings::get_ignore_mouse_drags

(

)

The diguyViewCameraSettings equivalent of the diguyViewCamera function with the same name.

bdiCamera* diguyViewCameraSettings::get_scripted_object ( )

inline

Friends And Related Function Documentation

friend class bdiCamera

friend

Member Data Documentation

bdiCamera* diguyViewCameraSettings::m_camera

private

A pointer to internal data.

---

The documentation for this class was generated from the following file:

• e:/Jenkins/workspace/diguy_apps_TOT_vc14_x64/include/diguyViewCameraSettings.h