 |
DI-Guy C++ SDK Reference
13.0
|
|
DI-Guy C++ SDK Reference
13.0
|
#include <diguyViewCamera.h>
Public Member Functions | |
General Functions | |
All functions in this section are callable from:
| |
| const char * | get_name () |
| Returns the name of the object. More... | |
| const char * | get_type_name () |
| Returns the type name of the object. More... | |
| void | set_near_plane (float near_plane) |
| This sets the distance from the camera to the near plane. More... | |
| float | get_near_plane () |
| Returns: distance from the camera to the near plane, in meters. More... | |
| void | set_far_plane (float far_plane) |
| This sets the distance from the camera to the far plane. More... | |
| float | get_far_plane () |
| Returns: distance from the camera to the far plane, in meters. More... | |
| void | set_fov (float fov) |
| This sets the field-of-view of the current camera. More... | |
| void | set_max_fov (float fov) |
| This sets the maximum field-of-view of the current camera. More... | |
| void | set_min_fov (float fov) |
| This sets the minimum field-of-view of the current camera. More... | |
| float | get_fov () |
| Returns: field-of-view of the camera, in degrees. More... | |
| float | get_min_fov () |
| Returns: min field-of-view of the camera, in degrees. More... | |
| float | get_max_fov () |
| Returns: max field-of-view of the camera, in degrees. More... | |
| void | set_aspect (float aspect) |
| This function sets the aspect ratio of the camera. More... | |
| float | get_aspect () |
| Returns: aspect ratio of the camera. More... | |
| void | set_position (float x, float y, float z) |
| This function sets the position of the camera. More... | |
| float | get_position_x () |
| Returns: x position, in meters from the origin. More... | |
| float | get_position_y () |
| Returns: y position, in meters from the origin. More... | |
| float | get_position_z () |
| Returns: z position, in meters from the origin. More... | |
| void | set_desired_position (float x, float y, float z, bool preserve_fix=false) |
| This function sets the desired position of the camera. More... | |
| void | set_orientation (float yaw, float roll, float pitch) |
| This function sets the orientation of the camera. More... | |
| void | set_orientation_roll (float roll) |
| This function sets the roll of the camera. More... | |
| float | get_orientation_yaw () |
| Returns: rotation about z axis, in degrees. More... | |
| float | get_orientation_roll () |
| Returns: rotation about x axis, in degrees. More... | |
| float | get_orientation_pitch () |
| Returns: rotation about y axis, in degrees. More... | |
| void | set_pitch_lower_limit (float limit) |
| Sets the lower limit of the camera pitch up. More... | |
| float | get_pitch_lower_limit () |
| Returns: lower limit of the camera pitch (up/down) More... | |
| void | set_pitch_upper_limit (float limit) |
| Sets the upper limit of the camera pitch down. More... | |
| float | get_pitch_upper_limit () |
| Returns: upper limit of the camera pitch (up/down) More... | |
| int | get_pitch_has_limits () |
| Returns: 1 if pitch has limits, 0 if not. More... | |
| void | set_distance (float distance) |
| This function sets the distance from the position to the fix point. More... | |
| void | set_max_track_distance (float distance) |
| This function sets the maximum allowed distance from the position to the fix point. More... | |
| void | set_min_track_distance (float distance) |
| This function sets the minimum allowed distance from the position to the fix point. More... | |
| float | get_distance () |
| Returns: distance from position to fix point, in meters. More... | |
| float | get_min_track_distance () |
| Returns: minimum allowed tracking distance, in meters; will be less than zero if not applicable. More... | |
| float | get_max_track_distance () |
| Returns: maximum allowed tracking distance, in meters; will be less than zero if not applicable. More... | |
| void | set_fix (float x, float y, float z) |
| This function sets the fix point of the camera. More... | |
| float | get_fix_x () |
| Returns: fix point in x, in meters. More... | |
| float | get_fix_y () |
| Returns: fix point in y, in meters. More... | |
| float | get_fix_z () |
| Returns: fix point in z, in meters. More... | |
| void | set_desired_fix (float x, float y, float z) |
| This function sets the desired fix point of the camera. More... | |
| int | set_move_mode (diguyViewCameraMoveMode move_mode) |
| This function sets the movement mode of the camera. More... | |
| diguyViewCameraMoveMode | get_move_mode () |
| Returns: the most recent setting made by set_move_mode() More... | |
| int | set_speed (float speed) |
| This function sets the movement speed of the camera when the camera is translating due to user input. More... | |
| float | get_speed () |
| Returns: the most recent setting made by set_speed() More... | |
| int | increase_speed () |
| This function increases the movement speed of the camera when the camera is translating due to user input. More... | |
| int | decrease_speed () |
| This function decreases the movement speed of the camera when the camera is translating due to user input. More... | |
| int | set_projection_mode (diguyViewCameraProjectionMode projection_mode) |
| This function sets the projection mode of the camera. More... | |
| diguyViewCameraProjectionMode | get_projection_mode () |
| Returns: the most recent setting made by set_projection_mode() More... | |
Load and Apply Functions | |
All functions in this section are callable from:
| |
| int | load_settings (const char *settings_name) |
| Loads the specified settings into this camera. More... | |
| int | load_settings (diguyViewCameraSettings *settings) |
| Loads the specified settings into this camera. More... | |
| void | apply_settings () |
| This function applies this camera's settings. More... | |
Far Position Camera Functions | |
The following functions are for working with a "far position", or high precision, cameras. One approach for dealing with high-magnitude floating point numbers is to simply use doubles instead of floats. However, many rendering pipelines use single-precision floats internally, making the use of doubles to store transformations only a partial solution. Another approach for rendering objects that are extremely far from the origin without having floating point precision problems is to move the camera and all objects it is observing closer to the origin. This avoids placing large magnitude numbers in transformation matrices, which with most graphics environments causes precision loss. This is the approach DI-Guy uses. DI-Guy internally stores high precision positions as a "far position": a segment (integer x and y coordinates), a segment size (a floating point number), and a floating point offset into the segment (float x, y, and z coordinates). This effectively compartmentalizes x and y coordinates into a grid where each cell, or segment, of the grid is of size (segment size x segment size) meters. (Currently z coordinates are stored "as is", in single precision floats.) The world coordinate position of a far position can be computed using the following formula: world position = (segment * segment_size) + segment_offset
If done using doubles, the above formula provides a very accurate position, even at very high magnitudes. This is the calculation the get_position_double() function uses. Assuming the camera and an object are in the same segment, the local (camera-relative) position of the object is simply its offset. If a diguyViewCamera is being used to control the graphics environment viewpoint, the viewpoint matrix can be calculated from the position segment offset and the fix segment offset. Example: float pos_x, pos_y, pos_z;
scenario_camera->get_position_segment_offset(&pos_x, &pos_y, &pos_z);
float fix_x, fix_y, fix_z;
scenario_camera->get_fix_segment_offset(&fix_x, &fix_y, &fix_z);
glMatrixMode(GL_MODELVIEW);
glLoadIdentity();
gluLookAt(pos_x, pos_y, pos_z,
fix_x, fix_y, fix_z,
0.0, 0.0, 1.0);
To render non-DI-Guy objects correctly, the segment origin translation must be subtracted from the position of the objects. This is done automatically for DI-Guy characters in the OpenGL version of DI-Guy if the diguy_ogl_set_use_far_positions(1) call is made. Example: Far position cameras are used in the diguy_ogl/view_far_settings/view_far_settings.cpp example. All functions in this section are callable from:
| |
| void | set_position_double (double x, double y, double z) |
| This function sets the position of this camera using double precision floating point numbers. More... | |
| void | get_position_double (double *x, double *y, double *z) |
| This function returns the world-space position of this camera. More... | |
| void | get_segment_origin (float *x, float *y, float *z) |
| This function returns the world-space origin of the far position segment the camera is in. More... | |
| void | get_position_segment_offset (float *x, float *y, float *z) |
| This function returns the far position segment offset part of the camera's position. More... | |
| void | get_fix_segment_offset (float *x, float *y, float *z) |
| This function returns the far position offset portion of the camera's fix point. More... | |
| void | set_fix_double (double x, double y, double z) |
| This function sets the fix point of the camera using double precision floating point numbers. More... | |
Look At and Look From Functions | |
All functions in this section are callable from:
| |
| void | set_track_name (const char *track_name) |
| This function sets the name of the character the camera should look at, if such an character can be found. More... | |
| const char * | get_track_name () |
| Returns: name of character to be looked at; see set_track_name() More... | |
| void | set_track_group_name (const char *track_name) |
| This function sets the name of the group the camera will track. More... | |
| const char * | get_track_group_name () |
| Returns: name of group to be looked at; see set_track_group_name() More... | |
| void | set_track_link_name (const char *track_link_name) |
| This function sets the name of the link to be tracked on the character specified by set_track_name(). More... | |
| const char * | get_track_link_name () |
| Returns: name of link to be looked at; see set_track_link_name() More... | |
| void | set_track_offset (float x, float y, float z) |
| This function sets the offset of the track position on the character specified by set_track_name(). More... | |
| float | get_track_offset_x () |
| Returns: x component of track offset; see set_track_offset() More... | |
| float | get_track_offset_y () |
| Returns: y component of track offset; see set_track_offset() More... | |
| float | get_track_offset_z () |
| Returns: z component of track offset; see set_track_offset() More... | |
| void | set_track_offset_is_in_world_coordinates (int value) |
| This function sets whether the offset of the track position is character-relative (pass 0) or in world coordinates (pass 1). More... | |
| int | get_track_offset_is_in_world_coordinates () |
| Returns: the most recent setting made by set_track_offset_is_in_world_coordinates(). More... | |
| void | set_dolly_name (const char *dolly_name) |
| This function sets the name of the entity this camera should look from, if such an entity can be found. More... | |
| const char * | get_dolly_name () |
| This function sets the name of the character the camera should look from, if such an character can be found. More... | |
| void | set_dolly_offset (float x, float y, float z) |
| This function sets the offset of the dolly position on the character specified by set_dolly_name(). More... | |
| float | get_dolly_offset_x () |
| Returns: x component of track offset; see set_dolly_offset() More... | |
| float | get_dolly_offset_y () |
| Returns: y component of track offset; see set_dolly_offset() More... | |
| float | get_dolly_offset_z () |
| Returns: z component of track offset; see set_dolly_offset() More... | |
| void | set_dolly_link_name (const char *dolly_link_name) |
| This function sets the name of the link to be dollied on the character specified by set_dolly_name(). More... | |
| const char * | get_dolly_link_name () |
| Returns: name of link to be looked from; see set_dolly_link_name() More... | |
| void | set_dolly_offset_is_in_world_coordinates (int value) |
| This function sets whether the offset of the dolly position is character-relative (pass 0) or in world coordinates (pass 1). More... | |
| int | get_dolly_offset_is_in_world_coordinates () |
| Returns: the most recent setting made by set_dolly_offset_is_in_world_coordinates(). More... | |
| int | get_symbolic_view () |
| Returns: if DI-Guy Scenario is rendering simplified 2D representations of characters. More... | |
C++/Script Callback Functions | |
| int | add_callback_script (int callback_id, const char *callback_script, const char *callback_script_type=NULL) |
| This function adds a user callback script. More... | |
| int | remove_callback_script (int callback_id, const char *callback_script, const char *callback_script_type=NULL) |
| This function removes a user callback script previously added with add_callback_script(). More... | |
Experimental Functions | |
The following functions are experimental and may change or disappear with no warning. Unless otherwise noted all are callable from:
| |
| void | set_speed_fov_degrees_per_wheel_click (float fov_change) |
| Sets number of degrees by which the camera FOV should change whenever the user moves the mouse wheel. More... | |
| float | get_speed_fov_degrees_per_wheel_click () |
| Gets the number of degrees by which the camera FOV should change whenever the user moves the mouse wheel. More... | |
| void | set_speed_meters_per_second (float speed) |
| Sets how fast the camera should move in various flyaround modes. More... | |
| float | get_speed_meters_per_second () |
| Gets how fast the camera should move in various flyaround modes. More... | |
| void | set_require_smooth_servo (int require) |
| Sets whether the camera should smoothly servo to its new desired position/heading (as opposed to instantly popping there). More... | |
| int | get_require_smooth_servo () |
| Gets whether the camera should smoothly servo to its new desired position/heading (as opposed to instantly popping there). More... | |
| void | set_servo_time_modifier (float modifier) |
| Sets a factor that determines how smoothly the camera should servo. More... | |
| float | get_servo_time_modifier () |
| Returns: The servo modifier time that determines how smoothly the camera should servo. More... | |
| void | set_track_camera_avoids_obstacles (int avoid) |
| Sets if the camera mover should make an effort to avoid obstacles that block visibility while a character or group is being tracked. More... | |
| int | get_track_camera_avoids_obstacles () |
| Gets whether the camera mover should make an effort to avoid obstacles that block visibility while a character or group is being tracked. More... | |
| void | set_ignore_mouse_drags (int ignore) |
| Sets if the camera should not respond to mouse drags. More... | |
| int | get_ignore_mouse_drags () |
| Gets whether the camera should ignore mouse drags. More... | |
| void | update_frustum (float *proj_matrix, float *model_matrix) |
| Allows the diguy camera to build an internal frustum needed for doing character and scene object culling. More... | |
C++ Callback Functions | |
| enum | { CALLBACK_ID_SETTINGS_CHANGED = 1 } |
| This is an enumeration of the different callbacks that can be registered with add_callback() and add_callback_script(). More... | |
| int | add_callback (int callback_id, diguyViewCameraCallback *callback, void *callback_params=0, void *callback_user_data=0) |
| This function adds a user callback. More... | |
| int | remove_callback (int callback_id, diguyViewCameraCallback *callback) |
| This function removes a user callback. More... | |
| int | remove_callback_with_user_data (int callback_id, void *callback_user_data) |
| This function removes a user callback. 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 () |
| diguyViewCamera (bdiCamera *camera) | |
| A private constructor. More... | |
| anonymous enum |
This is an enumeration of the different callbacks that can be registered with add_callback() and add_callback_script().
Usable From:
| Enumerator | |
|---|---|
| CALLBACK_ID_SETTINGS_CHANGED | |
|
private |
A private constructor.
| const char* diguyViewCamera::get_name | ( | ) |
Returns the name of the object.
This pointer will never be NULL.
Returns:
name of the object
| const char* diguyViewCamera::get_type_name | ( | ) |
Returns the type name of the object.
This pointer will never be NULL.
Returns:
type name of the object
| void diguyViewCamera::set_near_plane | ( | float | near_plane | ) |
This sets the distance from the camera to the near plane.
| near_plane | distance to near plane, in meters |
| float diguyViewCamera::get_near_plane | ( | ) |
Returns: distance from the camera to the near plane, in meters.
| void diguyViewCamera::set_far_plane | ( | float | far_plane | ) |
This sets the distance from the camera to the far plane.
| far_plane | distance to far plane, in meters |
| float diguyViewCamera::get_far_plane | ( | ) |
Returns: distance from the camera to the far plane, in meters.
| void diguyViewCamera::set_fov | ( | float | fov | ) |
This sets the field-of-view of the current camera.
| fov | field-of-view, in degrees |
| void diguyViewCamera::set_max_fov | ( | float | fov | ) |
This sets the maximum field-of-view of the current camera.
This affects the FOV that can be set via set_fov.
| fov | max field-of-view, in degrees |
| void diguyViewCamera::set_min_fov | ( | float | fov | ) |
This sets the minimum field-of-view of the current camera.
This affects the FOV that can be set via set_fov.
| fov | min field-of-view, in degrees |
| float diguyViewCamera::get_fov | ( | ) |
Returns: field-of-view of the camera, in degrees.
| float diguyViewCamera::get_min_fov | ( | ) |
Returns: min field-of-view of the camera, in degrees.
| float diguyViewCamera::get_max_fov | ( | ) |
Returns: max field-of-view of the camera, in degrees.
| void diguyViewCamera::set_aspect | ( | float | aspect | ) |
This function sets the aspect ratio of the camera.
| aspect | aspect ratio; 1.3333 (4/3) is the default |
| float diguyViewCamera::get_aspect | ( | ) |
Returns: aspect ratio of the camera.
| void diguyViewCamera::set_position | ( | float | x, |
| float | y, | ||
| float | z | ||
| ) |
This function sets the position of the camera.
| x,y,z | position in meters from the origin |
| float diguyViewCamera::get_position_x | ( | ) |
Returns: x position, in meters from the origin.
| float diguyViewCamera::get_position_y | ( | ) |
Returns: y position, in meters from the origin.
| float diguyViewCamera::get_position_z | ( | ) |
Returns: z position, in meters from the origin.
| void diguyViewCamera::set_desired_position | ( | float | x, |
| float | y, | ||
| float | z, | ||
| bool | preserve_fix = false |
||
| ) |
This function sets the desired position of the camera.
The camera will interpolate over time to this position.
| x,y,z | position in meters from the origin |
| void diguyViewCamera::set_orientation | ( | float | yaw, |
| float | roll, | ||
| float | pitch | ||
| ) |
This function sets the orientation of the camera.
Note that this affects the fix.
NOTE: Pitch angles are positive for looking down, not up!
| yaw | rotation about z axis, in degrees |
| roll | rotation about x axis, in degrees |
| pitch | rotation about y axis, in degrees |
| void diguyViewCamera::set_orientation_roll | ( | float | roll | ) |
This function sets the roll of the camera.
| roll | rotation about x axis, in radians |
| float diguyViewCamera::get_orientation_yaw | ( | ) |
Returns: rotation about z axis, in degrees.
| float diguyViewCamera::get_orientation_roll | ( | ) |
Returns: rotation about x axis, in degrees.
| float diguyViewCamera::get_orientation_pitch | ( | ) |
Returns: rotation about y axis, in degrees.
| void diguyViewCamera::set_pitch_lower_limit | ( | float | limit | ) |
Sets the lower limit of the camera pitch up.
Default is very close to -90 degrees.
NOTE: Pitch angles are positive for looking down, not up!
| limit | rotation about y axis, in degrees |
| float diguyViewCamera::get_pitch_lower_limit | ( | ) |
Returns: lower limit of the camera pitch (up/down)
| void diguyViewCamera::set_pitch_upper_limit | ( | float | limit | ) |
Sets the upper limit of the camera pitch down.
Default is very close to 90 degrees.
NOTE: Pitch angles are positive for looking down, not up!
| limit | rotation about y axis, in degrees |
| float diguyViewCamera::get_pitch_upper_limit | ( | ) |
Returns: upper limit of the camera pitch (up/down)
| int diguyViewCamera::get_pitch_has_limits | ( | ) |
Returns: 1 if pitch has limits, 0 if not.
| void diguyViewCamera::set_distance | ( | float | distance | ) |
This function sets the distance from the position to the fix point.
Note that this affects the fix values.
| distance | distance in meters |
| void diguyViewCamera::set_max_track_distance | ( | float | distance | ) |
This function sets the maximum allowed distance from the position to the fix point.
| distance | distance in meters; set to -1 if no max to be used |
| void diguyViewCamera::set_min_track_distance | ( | float | distance | ) |
This function sets the minimum allowed distance from the position to the fix point.
| distance | distance in meters; set to -1 if no min to be used |
| float diguyViewCamera::get_distance | ( | ) |
Returns: distance from position to fix point, in meters.
| float diguyViewCamera::get_min_track_distance | ( | ) |
Returns: minimum allowed tracking distance, in meters; will be less than zero if not applicable.
| float diguyViewCamera::get_max_track_distance | ( | ) |
Returns: maximum allowed tracking distance, in meters; will be less than zero if not applicable.
| void diguyViewCamera::set_fix | ( | float | x, |
| float | y, | ||
| float | z | ||
| ) |
This function sets the fix point of the camera.
Note that this affects the orientation.
| x,y,z | position in meters from the origin |
| float diguyViewCamera::get_fix_x | ( | ) |
Returns: fix point in x, in meters.
| float diguyViewCamera::get_fix_y | ( | ) |
Returns: fix point in y, in meters.
| float diguyViewCamera::get_fix_z | ( | ) |
Returns: fix point in z, in meters.
| void diguyViewCamera::set_desired_fix | ( | float | x, |
| float | y, | ||
| float | z | ||
| ) |
This function sets the desired fix point of the camera.
The camera will interpolate to there from its current fix over time.
| x,y,z | position in meters from the origin |
| int diguyViewCamera::set_move_mode | ( | diguyViewCameraMoveMode | move_mode | ) |
This function sets the movement mode of the camera.
In DI-Guy Scenario in Camera Input Mode, the movement mode of the camera determines what will happen when mouse buttons are pressed in the view window.
| move_mode | new movement mode of the camera; enumeration of type diguyViewCameraMoveMode |
| DIGUY_CAMERA_MOVE_FORWARD | left mouse press moves camera forward, right mouse press moves camera back |
| DIGUY_CAMERA_MOVE_SIDEWAYS | left mouse press moves camera left, right mouse press moves camera right |
| DIGUY_CAMERA_MOVE_VERTICAL | left mouse press moves camera up, right mouse press moves camera down |
Returns:
0 on success, -1 on failure
| diguyViewCameraMoveMode diguyViewCamera::get_move_mode | ( | ) |
Returns: the most recent setting made by set_move_mode()
| int diguyViewCamera::set_speed | ( | float | speed | ) |
This function sets the movement speed of the camera when the camera is translating due to user input.
In DI-Guy Scenario in Camera Input Mode, the movement speed of the camera determines how fast the camera will move when mouse buttons are pressed in the view window.
| speed | speed of camera movement is meters per second |
Returns:
0 on success, -1 on failure
| float diguyViewCamera::get_speed | ( | ) |
Returns: the most recent setting made by set_speed()
| int diguyViewCamera::increase_speed | ( | ) |
This function increases the movement speed of the camera when the camera is translating due to user input.
The increase is typically by a factor of 2.
Returns:
0 on success, -1 on failure
| int diguyViewCamera::decrease_speed | ( | ) |
This function decreases the movement speed of the camera when the camera is translating due to user input.
The decrease is typically by a factor of 2.
Returns:
0 on success, -1 on failure
| int diguyViewCamera::set_projection_mode | ( | diguyViewCameraProjectionMode | projection_mode | ) |
This function sets the projection mode of the camera.
In DI-Guy Scenario in Camera Input Mode, the movement mode of the camera determines what will happen when mouse buttons are pressed in the view window.
| projection_mode | new projection mode of the camera; enumeration of type diguyViewCameraProjectionMode |
| DIGUY_CAMERA_PROJECTION_PERSPECTIVE | standard perspective camera, can move and rotate freely |
| DIGUY_CAMERA_PROJECTION_PLANVIEW_XY | always views in negative Z direction |
| DIGUY_CAMERA_PROJECTION_PLANVIEW_XZ | always views in negative Y direction |
| DIGUY_CAMERA_PROJECTION_PLANVIEW_YZ | always views in negative X direction |
| diguyViewCameraProjectionMode diguyViewCamera::get_projection_mode | ( | ) |
Returns: the most recent setting made by set_projection_mode()
| int diguyViewCamera::load_settings | ( | const char * | settings_name | ) |
Loads the specified settings into this camera.
Returns:
0 on success, -1 on failure
| int diguyViewCamera::load_settings | ( | diguyViewCameraSettings * | settings | ) |
Loads the specified settings into this camera.
Returns:
0 on success, -1 on failure
| void diguyViewCamera::apply_settings | ( | ) |
This function applies this camera's settings.
OpenGL Version:
This function sets the current viewpoint in these environments based on information in this camera.
Direct3D Version:
This function has no effect. The viewpoint in these environments must be set manually.
| void diguyViewCamera::set_position_double | ( | double | x, |
| double | y, | ||
| double | z | ||
| ) |
This function sets the position of this camera using double precision floating point numbers.
The numbers will be converted internally into a DI-Guy far position.
| x | x position, in meters |
| y | y position, in meters |
| z | z position, in meters |
| void diguyViewCamera::get_position_double | ( | double * | x, |
| double * | y, | ||
| double * | z | ||
| ) |
This function returns the world-space position of this camera.
These values are computed from the DI-Guy far position of the camera. The results are placed into the passed pointers.
| x | x position, in meters |
| y | y position, in meters |
| z | z position, in meters |
| void diguyViewCamera::get_segment_origin | ( | float * | x, |
| float * | y, | ||
| float * | z | ||
| ) |
This function returns the world-space origin of the far position segment the camera is in.
This segment origin plus the position segment offset returned by get_position_segment_offset() yields the final world-space position of the camera.
The results are placed into the passed pointers.
| x | x component of origin, in meters |
| y | y component of origin, in meters |
| z | z component of origin, in meters |
| void diguyViewCamera::get_position_segment_offset | ( | float * | x, |
| float * | y, | ||
| float * | z | ||
| ) |
This function returns the far position segment offset part of the camera's position.
The results are placed into the passed pointers.
| x | x component of segment offset, in meters |
| y | y component of segment offset, in meters |
| z | z component of segment offset, in meters |
| void diguyViewCamera::get_fix_segment_offset | ( | float * | x, |
| float * | y, | ||
| float * | z | ||
| ) |
This function returns the far position offset portion of the camera's fix point.
The results are placed into the passed pointers.
| x | x component of fix segment offset, in meters |
| y | y component of fix segment offset, in meters |
| z | z component of fix segment offset, in meters |
| void diguyViewCamera::set_fix_double | ( | double | x, |
| double | y, | ||
| double | z | ||
| ) |
This function sets the fix point of the camera using double precision floating point numbers.
The numbers will be converted internally into a DI-Guy far position. Note that this affects the orientation.
| x | x position, in meters |
| y | y position, in meters |
| z | z position, in meters |
| void diguyViewCamera::set_track_name | ( | const char * | track_name | ) |
This function sets the name of the character the camera should look at, if such an character can be found.
This will cause fix values to change over time.
By default the camera will look at the idealized position of the character (a spot on the ground typically under the center of gravity for human characters). To look at a particular part of a character, call set_track_link_name().
The spot looked at on a link can be offset by calling set_track_offset(). Whether the offset is in world coordinates or character-local coordinates is controlled by a call to set_track_offset_is_in_world_coordinates().
| track_name | name of character to look at, or NULL if no character is to be tracked |
C++ Example
The following example shows how to use some of the pose functions.
| const char* diguyViewCamera::get_track_name | ( | ) |
Returns: name of character to be looked at; see set_track_name()
| void diguyViewCamera::set_track_group_name | ( | const char * | track_name | ) |
This function sets the name of the group the camera will track.
| track_name | name of group to look at; pass NULL to un-set track group |
| const char* diguyViewCamera::get_track_group_name | ( | ) |
Returns: name of group to be looked at; see set_track_group_name()
| void diguyViewCamera::set_track_link_name | ( | const char * | track_link_name | ) |
This function sets the name of the link to be tracked on the character specified by set_track_name().
See set_track_name() for more information.
| track_link_name | name of link to look at, or NULL if the base link is to be tracked |
| const char* diguyViewCamera::get_track_link_name | ( | ) |
Returns: name of link to be looked at; see set_track_link_name()
| void diguyViewCamera::set_track_offset | ( | float | x, |
| float | y, | ||
| float | z | ||
| ) |
This function sets the offset of the track position on the character specified by set_track_name().
See set_track_name() for more information.
Whether the offset is in world coordinates or character-local coordinates is controlled by a call to set_track_offset_is_in_world_coordinates().
| x,y,z | offset, in meters, of track point |
| float diguyViewCamera::get_track_offset_x | ( | ) |
Returns: x component of track offset; see set_track_offset()
| float diguyViewCamera::get_track_offset_y | ( | ) |
Returns: y component of track offset; see set_track_offset()
| float diguyViewCamera::get_track_offset_z | ( | ) |
Returns: z component of track offset; see set_track_offset()
| void diguyViewCamera::set_track_offset_is_in_world_coordinates | ( | int | value | ) |
This function sets whether the offset of the track position is character-relative (pass 0) or in world coordinates (pass 1).
Default value is 0.
| value | pass 0 for character-relative, 0 for world coordinates |
| int diguyViewCamera::get_track_offset_is_in_world_coordinates | ( | ) |
Returns: the most recent setting made by set_track_offset_is_in_world_coordinates().
| void diguyViewCamera::set_dolly_name | ( | const char * | dolly_name | ) |
This function sets the name of the entity this camera should look from, if such an entity can be found.
This will cause position values to change over time.
| dolly_name | name of entity to look from, or NULL if no entity is to influence camera position |
| const char* diguyViewCamera::get_dolly_name | ( | ) |
This function sets the name of the character the camera should look from, if such an character can be found.
This will cause position values to change over time.
| dolly_name | name of character to look from, or NULL if no character is to influence camera position |
| void diguyViewCamera::set_dolly_offset | ( | float | x, |
| float | y, | ||
| float | z | ||
| ) |
This function sets the offset of the dolly position on the character specified by set_dolly_name().
See set_dolly_name() for more information.
Whether the offset is in world coordinates or character-local coordinates is controlled by a call to set_dolly_offset_is_in_world_coordinates().
| x,y,z | offset, in meters, of dolly point |
| float diguyViewCamera::get_dolly_offset_x | ( | ) |
Returns: x component of track offset; see set_dolly_offset()
| float diguyViewCamera::get_dolly_offset_y | ( | ) |
Returns: y component of track offset; see set_dolly_offset()
| float diguyViewCamera::get_dolly_offset_z | ( | ) |
Returns: z component of track offset; see set_dolly_offset()
| void diguyViewCamera::set_dolly_link_name | ( | const char * | dolly_link_name | ) |
This function sets the name of the link to be dollied on the character specified by set_dolly_name().
| dolly_link_name | name of link to look from, or NULL if the position link is to influence camera position |
| const char* diguyViewCamera::get_dolly_link_name | ( | ) |
Returns: name of link to be looked from; see set_dolly_link_name()
| void diguyViewCamera::set_dolly_offset_is_in_world_coordinates | ( | int | value | ) |
This function sets whether the offset of the dolly position is character-relative (pass 0) or in world coordinates (pass 1).
Default value is 0.
| value | pass 0 for character-relative, 0 for world coordinates |
| int diguyViewCamera::get_dolly_offset_is_in_world_coordinates | ( | ) |
Returns: the most recent setting made by set_dolly_offset_is_in_world_coordinates().
| int diguyViewCamera::get_symbolic_view | ( | ) |
Returns: if DI-Guy Scenario is rendering simplified 2D representations of characters.
| int diguyViewCamera::add_callback | ( | int | callback_id, |
| diguyViewCameraCallback * | callback, | ||
| void * | callback_params = 0, |
||
| void * | callback_user_data = 0 |
||
| ) |
This function adds a user callback.
| callback | pointer to function with prototype diguyViewCameraCallback (typedefed above) |
| callback_id | integer id of when this callback is to be called |
| callback_params | struct containing additional parameters needed by some callbacks; actual type depends on callback_id |
| callback_user_data | pointer for user's own use; DI-Guy will do nothing to the contents of this pointer beyond passing it back when the callback is invoked |
callback_id should be one of the following values:
CALLBACK_ID_SETTINGS_CHANGED
This callback will be called if the current settings of this camera change
Callbacks return a value of type diguyCallbackReturn, which will be DIGUY_CALLBACK_STOP or DIGUY_CALLBACK_CONTINUE. If the callback returns DIGUY_CALLBACK_STOP, the default handler of the function will not be called; the callback is asserting that it has done everything necessary for the function call. If the callback returns DIGUY_CALLBACK_CONTINUE, the default handler for the function will be called after the callback.
Returns:
0 on success, -1 on failure
| int diguyViewCamera::remove_callback | ( | int | callback_id, |
| diguyViewCameraCallback * | callback | ||
| ) |
This function removes a user callback.
All callbacks matching the specified callback_id and callback function will be removed.
| callback_id | integer id of when this callback is to be called |
| callback | pointer to function with prototype diguyViewCameraCallback (typedefed above) |
Returns:
0 on success, -1 on failure
| int diguyViewCamera::remove_callback_with_user_data | ( | int | callback_id, |
| void * | callback_user_data | ||
| ) |
This function removes a user callback.
All callbacks matching the specified callback_id and callback_user_data pointer will be removed.
| callback_id | integer id of when this callback is to be called |
| callback_user_data | pointer for user's own use |
Returns:
0 on success, -1 on failure
| int diguyViewCamera::add_callback_script | ( | int | callback_id, |
| const char * | callback_script, | ||
| const char * | callback_script_type = NULL |
||
| ) |
This function adds a user callback script.
Callback scripts can be removed with remove_callback_script().
| callback_id | integer id of the callback |
| callback_script | script text of callback to be added |
| callback_script_type | the type of script contained in callback_script |
If NULL is passed for callback_script_type, a default script type will be derived based on the default script interpreter of the scenario.
lua specific:
When the script is called, the object for which it is being called will be in the callback_object local.
To pass NULL when calling from a lua script, use nil.
Returns:
0 on success, -1 on failure
| int diguyViewCamera::remove_callback_script | ( | int | callback_id, |
| const char * | callback_script, | ||
| const char * | callback_script_type = NULL |
||
| ) |
This function removes a user callback script previously added with add_callback_script().
| callback_id | integer id of the callback |
| callback_script | script text of callback previously added |
| callback_script_type | the type of script contained in callback_script |
If NULL is passed for callback_script, all callback scripts whose ids match callback_id and whose types match callback_script_type will be removed.
If NULL is passed for callback_script_type, a default script type will be derived based on the default script interpreter of the scenario.
lua specific:
To pass NULL when calling from a lua script, use nil.
Returns:
0 on success, -1 on failure
| void diguyViewCamera::set_speed_fov_degrees_per_wheel_click | ( | float | fov_change | ) |
Sets number of degrees by which the camera FOV should change whenever the user moves the mouse wheel.
| fov_change | change to FOV in degrees |
| float diguyViewCamera::get_speed_fov_degrees_per_wheel_click | ( | ) |
Gets the number of degrees by which the camera FOV should change whenever the user moves the mouse wheel.
Returns:
change to FOV, in degrees
| void diguyViewCamera::set_speed_meters_per_second | ( | float | speed | ) |
Sets how fast the camera should move in various flyaround modes.
| speed | flying speed in meters per second |
| float diguyViewCamera::get_speed_meters_per_second | ( | ) |
Gets how fast the camera should move in various flyaround modes.
Returns:
speed in meters per second
| void diguyViewCamera::set_require_smooth_servo | ( | int | require | ) |
Sets whether the camera should smoothly servo to its new desired position/heading (as opposed to instantly popping there).
| require | 0 for smooth servoing |
| int diguyViewCamera::get_require_smooth_servo | ( | ) |
Gets whether the camera should smoothly servo to its new desired position/heading (as opposed to instantly popping there).
Returns:
1 if smooth servoing is required; 0 if not
| void diguyViewCamera::set_servo_time_modifier | ( | float | modifier | ) |
Sets a factor that determines how smoothly the camera should servo.
If a high number (e.g. 10.0), the camera will servo quickly. If a low number (e.g. 1.0), it will servo more slowly.
modifier
| float diguyViewCamera::get_servo_time_modifier | ( | ) |
Returns: The servo modifier time that determines how smoothly the camera should servo.
| void diguyViewCamera::set_track_camera_avoids_obstacles | ( | int | avoid | ) |
Sets if the camera mover should make an effort to avoid obstacles that block visibility while a character or group is being tracked.
| avoids | true for avoidance |
| int diguyViewCamera::get_track_camera_avoids_obstacles | ( | ) |
Gets whether the camera mover should make an effort to avoid obstacles that block visibility while a character or group is being tracked.
Returns:
1 if obstacle avoidance should be attempted
| void diguyViewCamera::set_ignore_mouse_drags | ( | int | ignore | ) |
Sets if the camera should not respond to mouse drags.
Responding is the default.
| avoids | 1 to ignore mouse drags; 0 if not |
| int diguyViewCamera::get_ignore_mouse_drags | ( | ) |
Gets whether the camera should ignore mouse drags.
Returns:
1 if mouse drags are to be ignored; 0 if not
| void diguyViewCamera::update_frustum | ( | float * | proj_matrix, |
| float * | model_matrix | ||
| ) |
Allows the diguy camera to build an internal frustum needed for doing character and scene object culling.
projection_matrix and model_matrix should be pointers to 16 floats in OpenGL style matrix format.
This function is not callable from lua.
|
inline |
|
friend |
|
private |
A pointer to internal data.
1.8.3.1 
