Brief Index      Full Index      Events Index      I.M. Reference

Show_Camera


Functions

void Show_Camera (HC_POINT *position, HC_POINT *target, HC_VECTOR *up, float *width, float *height, char *projection)
void DShow_Camera (HCD_POINT *position, HCD_POINT *target, HCD_POINT *up, double *width, double *height, char *projection)
int PShow_Net_Camera (int key_count, const HC_KEY *path_keys, HC_POINT *position, HC_POINT *target, HC_VECTOR *up, float *width, float *height, char *projection)
int DPShow_Net_Camera (int key_count, const HC_KEY *path_keys, HC_DPOINT *position, HC_DPOINT *target, HC_DVECTOR *up, double *width, double *height, char *projection)
void Show_Camera_Field (float *width, float *height)
void DShow_Camera_Field (double *width, double *height)
int PShow_Net_Camera_Field (int key_count, const HC_KEY *path_keys, float *width, float *height)
int DPShow_Net_Camera_Field (int key_count, const HC_KEY *path_keys, double *width, double *height)
void Show_Camera_Position (float *x, float *y, float *z)
void DShow_Camera_Position (double *x, double *y, double *z)
int PShow_Net_Camera_Position (int key_count, const HC_KEY *path_keys, float *x, float *y, float *z)
void DPShow_Net_Camera_Position (int key_count, const HC_KEY *path_keys, double *x, double *y, double *z)
void Show_Camera_Projection (char *projection)
void PShow_Net_Camera_Projection (int key_count, const HC_KEY *path_keys, char *projection)
void Show_Camera_Target (float *x, float *y, float *z)
void DShow_Camera_Target (double *x, double *y, double *z)
int PShow_Net_Camera_Target (int key_count, const HC_KEY *path_keys, float *x, float *y, float *z)
void DPShow_Net_Camera_Target (int key_count, const HC_KEY *path_keys, double *x, double *y, double *z)
void Show_Camera_Up_Vector (float *x, float *y, float *z)
void DShow_Camera_Up_Vector (double *x, double *y, double *z)
int PShow_Net_Camera_Up_Vector (int key_count, const HC_KEY *path_keys, float *x, float *y, float *z)
int DPShow_Net_Camera_Up_Vector (int key_count, const HC_KEY *path_keys, double *x, double *y, double *z)

Function Documentation

void Show_Camera ( HC_POINT *  position,
HC_POINT *  target,
HC_VECTOR *  up,
float *  width,
float *  height,
char *  projection 
)

Returns the complete specification of the viewing camera's position, orientation, and field of view.

Parameters:
position - Position in the scene, in user coordinates, at which the camera is set. Passed by reference. Returned to user.
target - Coordinates in the scene toward which the camera is pointed. Passed by reference. Returned to user.
up - Direction the top of the camera faces: the "upvector". Passed by reference. Returned to user.
width - Width of the minimum visible area around the target. Passed by reference. Returned to user.
height - Height of the minimum visible area around the target. Passed by reference. Returned to user.
projection - Special constant---either "Perspective", "Orthographic", "Stretched", or an "oblique" form (see Set_Camera_Projection() or Set_Camera_By_Volume() ). May be uppercase, lower case, or mixed case. Passed by reference. Returned to user.

DETAILS

No additional details. See Set_Camera()

See also:
Set_Camera_By_Volume, Set_Camera_Field, Set_Camera_Position, Set_Camera_Projection, Set_Camera_Target, Set_Camera_Up_Vector, Zoom_Camera, Orbit_Camera, Pan_Camera, Dolly_Camera, Roll_Camera, Set_Window, Translate_Object, Rotate_Object

void DShow_Camera ( HCD_POINT *  position,
HCD_POINT *  target,
HCD_POINT *  up,
double *  width,
double *  height,
char *  projection 
)

Similar to Show_Camera() but accepts double-precision values. This command should be used in conjunction with other double-precision Set_Camera functions.

Parameters:
position - Position in the scene, in user coordinates, at which the camera is set. Passed by reference. Returned to user.
target - Coordinates in the scene toward which the camera is pointed. Passed by reference. Returned to user.
up - Direction the top of the camera faces: the "upvector". Passed by reference. Returned to user.
width - Width of the minimum visible area around the target. Passed by reference. Returned to user.
height - Height of the minimum visible area around the target. Passed by reference. Returned to user.
projection - Special constant---either "Perspective", "Orthographic", "Stretched", or an "oblique" form (see Set_Camera_Projection() or Set_Camera_By_Volume() ). May be uppercase, lower case, or mixed case. Passed by reference. Returned to user.

DETAILS

No additional details. See Show_Camera().

int PShow_Net_Camera ( int  key_count,
const HC_KEY *  path_keys,
HC_POINT *  position,
HC_POINT *  target,
HC_VECTOR *  up,
float *  width,
float *  height,
char *  projection 
)

Returns the net effective setting along a discrete segment path.

Parameters:
key_count The size of pathkeys
path_keys An array of HC_KEY's delineating a path of segments.
position - Position in the scene, in user coordinates, at which the camera is set. Passed by reference. Returned to user.
target - Coordinates in the scene toward which the camera is pointed. Passed by reference. Returned to user.
up - Direction the top of the camera faces: the "upvector". Passed by reference. Returned to user.
width - Width of the minimum visible area around the target. Passed by reference. Returned to user.
height - Height of the minimum visible area around the target. Passed by reference. Returned to user.
projection - Special constant---either "Perspective", "Orthographic", "Stretched", or an "oblique" form (see Set_Camera_Projection() or Set_Camera_By_Volume() ). May be uppercase, lower case, or mixed case. Passed by reference. Returned to user.
Returns:
An integer indicating what type of camera was found (see details).

DETAILS

As with all PShow_Net_* routines, pathkeys[0] represents the "most local" or "leaf" segment, and pathkeys[keycount-1] represents the highest segment. If the path is incomplete, missing segments are filled in, if possible. Missing segments must be part of the same direct ancestry in order to be filled in. If the desired path contains an include link, the shortest unambiguous set of pathkeys would be [leaf, includelink, root], where includelink is the return value from Include_Segment().

By default, HOOPS Visualize will determine the net attribute from the last specified key all the way to the root. If you add -1 at the end of the array, the PShow_Net routines will not proceed beyond the end of the last specified key.

A return value of 0 indicates no camera was found. A value of 1 indicates a single-precision camera was found. A value of 2 indicates a double-precision camera was found.

int DPShow_Net_Camera ( int  key_count,
const HC_KEY *  path_keys,
HC_DPOINT *  position,
HC_DPOINT *  target,
HC_DVECTOR *  up,
double *  width,
double *  height,
char *  projection 
)

Similar to PShow_Net_Camera(), but operates on double-precision cameras.

Parameters:
key_count The size of pathkeys
path_keys An array of HC_KEY's delineating a path of segments.
position - Position in the scene, in user coordinates, at which the camera is set. Passed by reference. Returned to user.
target - Coordinates in the scene toward which the camera is pointed. Passed by reference. Returned to user.
up - Direction the top of the camera faces: the "upvector". Passed by reference. Returned to user.
width - Width of the minimum visible area around the target. Passed by reference. Returned to user.
height - Height of the minimum visible area around the target. Passed by reference. Returned to user.
projection - Special constant---either "Perspective", "Orthographic", "Stretched", or an "oblique" form (see Set_Camera_Projection() or Set_Camera_By_Volume() ). May be uppercase, lower case, or mixed case. Passed by reference. Returned to user.
Returns:
An integer indicating what type of camera was found (see details).

void Show_Camera_Field ( float *  width,
float *  height 
)

Returns the viewing camera's field of view.

Parameters:
width - Width of the minimum visible area around the target. Passed by reference. Returned to user.
height - Height of the minimum visible area around the target. Passed by reference. Returned to user.

void DShow_Camera_Field ( double *  width,
double *  height 
)

Similar to Show_Camera_Field(). This command should be used in conjunction with the other double-precision Set_Camera functions.

Parameters:
width - Width of the minimum visible area around the target. Passed by reference. Returned to user.
height - Height of the minimum visible area around the target. Passed by reference. Returned to user.

int PShow_Net_Camera_Field ( int  key_count,
const HC_KEY *  path_keys,
float *  width,
float *  height 
)

Returns the net effective setting along a discrete segment path.

Parameters:
key_count The size of pathkeys
path_keys An array of HC_KEY's delineating a path of segments.
width - Width of the minimum visible area around the target. Passed by reference. Returned to user.
height - Height of the minimum visible area around the target. Passed by reference. Returned to user.
Returns:
An integer indicating what type of camera was found (see details).

DETAILS

As with all PShow_Net_* routines, pathkeys[0] represents the lowest segment (the "most local" or "leaf"), and pathkeys[keycount-1] represents the highest segment. If the path is incomplete, missing segments are filled in if possible. Missing segments must be part of the same direct ancestry in order to be filled in. If the desired path contains an include link, the shortest unambiguous set of pathkeys would be [leaf, includelink, root], where includelink is the return value from Include_Segment().

By default, HOOPS will determine the net attribute from the last specified key all the way to the root. If you add -1 at the end of the array, the PShow_Net routines will not proceed beyond the end of the last specified key.

A return value of 0 indicates no camera was found. A value of 1 indicates a single-precision camera was found. A value of 2 indicates a double-precision camera was found.

int DPShow_Net_Camera_Field ( int  key_count,
const HC_KEY *  path_keys,
double *  width,
double *  height 
)

Similar to PShow_Net_Camera_Field(), but operates on double-precision cameras.

Parameters:
key_count The size of pathkeys
path_keys An array of HC_KEY's delineating a path of segments.
width - Width of the minimum visible area around the target. Passed by reference. Returned to user.
height - Height of the minimum visible area around the target. Passed by reference. Returned to user.
Returns:
An integer indicating what type of camera was found (see details).

void Show_Camera_Position ( float *  x,
float *  y,
float *  z 
)

Returns the viewing camera's position.

Parameters:
x - X-coordinate of the camera position. Passed by reference. Returned to user.
y - Y-coordinate of the camera position. Passed by reference. Returned to user.
z - Z-coordinate of the camera position. Passed by reference. Returned to user.

void DShow_Camera_Position ( double *  x,
double *  y,
double *  z 
)

Similar to Show_Camera_Position(). This command should be used in conjunction with other double-precision Set_Camera functions.

Parameters:
x - X-coordinate of the camera position. Passed by reference. Returned to user.
y - Y-coordinate of the camera position. Passed by reference. Returned to user.
z - Z-coordinate of the camera position. Passed by reference. Returned to user.

int PShow_Net_Camera_Position ( int  key_count,
const HC_KEY *  path_keys,
float *  x,
float *  y,
float *  z 
)

Returns the net effective setting along a discrete segment path.

Parameters:
key_count The size of pathkeys
path_keys An array of HC_KEY's delineating a path of segments.
x - X-coordinate of the camera position. Passed by reference. Returned to user.
y - Y-coordinate of the camera position. Passed by reference. Returned to user.
z - Z-coordinate of the camera position. Passed by reference. Returned to user.
Returns:
An integer indicating what type of camera was found (see details).

DETAILS

As with all PShow_Net_* routines, pathkeys[0] represents the lowest (a.k.a the "most local" or "leaf"), and pathkeys[keycount-1] represents the highest segment. If the path is incomplete, missing segments are filled in if possible. Missing segments must be part of the same direct ancestry in order to be filled in. If the desired path contains an include link, the shortest unambiguous set of pathkeys would be [leaf, includelink, root], where includelink is the return value from Include_Segment().

By default, HOOPS Visualize will determine the net attribute from the last specified key all the way to the root. If you add -1 at the end of the array, the PShow_Net routines will not proceed beyond the end of the last specified key.

A return value of 0 indicates no camera was found. A value of 1 indicates a single-precision camera was found. A value of 2 indicates a double-precision camera was found.

void DPShow_Net_Camera_Position ( int  key_count,
const HC_KEY *  path_keys,
double *  x,
double *  y,
double *  z 
)

Similar to PShow_Net_Camera_Position(), but operates on double-precision cameras.

Parameters:
key_count The size of pathkeys
path_keys An array of HC_KEY's delineating a path of segments.
x - X-coordinate of the camera position. Passed by reference. Returned to user.
y - Y-coordinate of the camera position. Passed by reference. Returned to user.
z - Z-coordinate of the camera position. Passed by reference. Returned to user.
Returns:
An integer indicating what type of camera was found (see details).

void Show_Camera_Projection ( char *  projection  ) 

Returns the viewing camera's projection.

Parameters:
projection - Special constant---either "Perspective", "Orthographic", "Stretched", or an "oblique" form (see Set_Camera_Projection() or Set_Camera_By_Volume() ). May be uppercase, lower case, or mixed case. Passed by reference. Returned to user.

void PShow_Net_Camera_Projection ( int  key_count,
const HC_KEY *  path_keys,
char *  projection 
)

Returns the net effective setting along a discrete segment path specified with a set of keys.

Parameters:
key_count The size of pathkeys
path_keys An array of HC_KEY's delineating a path of segments.
projection - Special constant---either "Perspective", "Orthographic", "Stretched", or an "oblique" form (see Set_Camera_Projection() or Set_Camera_By_Volume() ). May be uppercase, lower case, or mixed case. Passed by reference. Returned to user.

DETAILS

As with all PShow_Net_* routines, pathkeys[0] represents the lowest (a.k.a the "most local" or "leaf"), and pathkeys[keycount-1] represents the highest segment. If the path is incomplete, missing segments are filled in if possible. Missing segments must be part of the same direct ancestry in order to be filled in. If the desired path contains an include link, the shortest unambiguous set of pathkeys would be [leaf, includelink, root], where includelink is the return value from Include_Segment().

By default, HOOPS will determine the Net attribute from the last specified key all the way to the root. If you add -1 at the end of the array, the PShow_Net routines will not proceed beyond the end of the last specified key.

void Show_Camera_Target ( float *  x,
float *  y,
float *  z 
)

Returns the viewing camera's target.

Parameters:
x - X-coordinate of the camera target. Passed by reference. Returned to user.
y - Y-coordinate of the camera target. Passed by reference. Returned to user.
z - Z-coordinate of the camera target. Passed by reference. Returned to user.

void DShow_Camera_Target ( double *  x,
double *  y,
double *  z 
)

Similar to Show_Camera_Target(). This command should be used in conjunction with other double-precision Set_Camera functions.

Parameters:
x - X-coordinate of the camera target. Passed by reference. Returned to user.
y - Y-coordinate of the camera target. Passed by reference. Returned to user.
z - Z-coordinate of the camera target. Passed by reference. Returned to user.

int PShow_Net_Camera_Target ( int  key_count,
const HC_KEY *  path_keys,
float *  x,
float *  y,
float *  z 
)

Returns the net effective setting along a specified path of keys rather than the local one.

Parameters:
key_count The size of pathkeys
path_keys An array of HC_KEY's delineating a path of segments.
x - X-coordinate of the camera target. Passed by reference. Returned to user.
y - Y-coordinate of the camera target. Passed by reference. Returned to user.
z - Z-coordinate of the camera target. Passed by reference. Returned to user.
Returns:
An integer indicating what type of camera was found (see details).

DETAILS

As with all PShow_Net_* routines, pathkeys[0] represents the lowest (a.k.a the "most local" or "leaf"), and pathkeys[keycount-1] represents the highest segment. If the path is incomplete, missing segments are filled in if possible. Missing segments must be part of the same direct ancestry in order to be filled in. If the desired path contains an include link, the shortest unambiguous set of pathkeys would be [leaf, includelink, root], where includelink is the return value from Include_Segment().

By default, HOOPS Visualize will determine the net attribute from the last specified key all the way to the root. If you add -1 at the end of the array, the PShow_Net routines will not proceed beyond the end of the last specified key.

A return value of 0 indicates no camera was found. A value of 1 indicates a single-precision camera was found. A value of 2 indicates a double-precision camera was found.

void DPShow_Net_Camera_Target ( int  key_count,
const HC_KEY *  path_keys,
double *  x,
double *  y,
double *  z 
)

Similar to PShow_Net_Camera_Target(), but operates on double-precision cameras.

Parameters:
key_count The size of pathkeys
path_keys An array of HC_KEY's delineating a path of segments.
x - X-coordinate of the camera target. Passed by reference. Returned to user.
y - Y-coordinate of the camera target. Passed by reference. Returned to user.
z - Z-coordinate of the camera target. Passed by reference. Returned to user.
Returns:
An integer indicating what type of camera was found (see details).

void Show_Camera_Up_Vector ( float *  x,
float *  y,
float *  z 
)

Returns the viewing camera's up-vector.

Parameters:
x - X-coordinate of the camera up-vector. Passed by reference. Returned to user.
y - Y-coordinate of the camera up-vector. Passed by reference. Returned to user.
z - Z-coordinate of the camera up-vector. Passed by reference. Returned to user.

void DShow_Camera_Up_Vector ( double *  x,
double *  y,
double *  z 
)

Similar to Show_Camera_Up_Vector(). This command should be used in conjunction with the other double-precision Set_Camera functions.

Parameters:
x - X-coordinate of the camera up-vector. Passed by reference. Returned to user.
y - Y-coordinate of the camera up-vector. Passed by reference. Returned to user.
z - Z-coordinate of the camera up-vector. Passed by reference. Returned to user.

int PShow_Net_Camera_Up_Vector ( int  key_count,
const HC_KEY *  path_keys,
float *  x,
float *  y,
float *  z 
)

Returns the net effective setting along a discrete segment path.

Parameters:
key_count The size of pathkeys
path_keys An array of HC_KEY's delineating a path of segments.
x - X-coordinate of the camera up-vector. Passed by reference. Returned to user.
y - Y-coordinate of the camera up-vector. Passed by reference. Returned to user.
z - Z-coordinate of the camera up-vector. Passed by reference. Returned to user.
Returns:
An integer indicating what type of camera was found (see details).

DETAILS

As with all PShow_Net_* routines, pathkeys[0] represents the lowest (a.k.a the "most local" or "leaf"), and pathkeys[keycount-1] represents the highest segment. If the path is incomplete, missing segments are filled in if possible. Missing segments must be part of the same direct ancestry in order to be filled in. If the desired path contains an include link, the shortest unambiguous set of pathkeys would be [leaf, includelink, root], where includelink is the return value from Include_Segment().

By default, HOOPS Visualize will determine the net attribute from the last specified key all the way to the root. If you add -1 at the end of the array, the PShow_Net routines will not proceed beyond the end of the last specified key.

A return value of 0 indicates no camera was found. A value of 1 indicates a single-precision camera was found. A value of 2 indicates a double-precision camera was found.

int DPShow_Net_Camera_Up_Vector ( int  key_count,
const HC_KEY *  path_keys,
double *  x,
double *  y,
double *  z 
)

Similar to PShow_Net_Camera_Up_Vector(), but operates on double-precision cameras.

Parameters:
key_count The size of pathkeys
path_keys An array of HC_KEY's delineating a path of segments.
x - X-coordinate of the camera up-vector. Passed by reference. Returned to user.
y - Y-coordinate of the camera up-vector. Passed by reference. Returned to user.
z - Z-coordinate of the camera up-vector. Passed by reference. Returned to user.
Returns:
An integer indicating what type of camera was found (see details).

Brief Index      Full Index      Events Index      I.M. Reference