class DVgeometry

A toplevel object which provided services such as animation and display list creation.

Public Fields
Tk_TimerToken timerID
DVnamed_properties named_properties

Public Methods
DVgeometry(int (*)(DVcreate_image_arguments &)=NULL): Default constructor.
~DVgeometry(): default destuctor
void reset(): initialize
int read_file(char *input_string): Read a file based on a filename and make a display list
int load_file(): Load a file based on the default filename and make a display list
int draw(): Draw the scene to the current OpenGL drawable.
void drawing_area(Tk_Window val): Set the drawing area widget for the scene
else void drawing_area(Widget val): Set the drawing area widget for the scene
endif void zoom(float val): Multiply the current zoom vale by the arguement
void rotate(float *val): rotate by the new quaternion
void translate(float x, float y): translate
void get_zoom(float *out)
void get_rotate(float *out)
void get_translate(float *out)
void set_zoom(float *in)
void set_rotate(float *in)
void set_translate(float *in)
float get_zoom(): Return the current zoom value
void useTimer(): Turn on the timer.
void noTimer(): Turn off the timer
int ifTimer(): Ask is the timer is turned on
void set_background_color(const DVcolor&)
void set_background_color(const LCVMstring&)
void set_background_color(const DVrich_property_item<DVcolor>&)
void set_background_color(const DVexplicit_property_item<DVcolor>&)
void set_background_color(const DVnamed_property_item<DVcolor>&)
int get_animation_optimize_flag() const: Return the value of the animation_optimize_flag.
DVgeometry& set_animation_optimize_flag(const int): Set the value of the animation_optimize_flag
int get_first_frame_number() const: Gets the first frame number.
int get_last_frame_number() const: Gets the last frame number.
void set_first_frame_number(int): Sets the first frame number.
void set_last_frame_number(int): Sets the last frame number.
DVgeometry& set_animation_frames(const int, const int, const int): Set the animation first frame, last frame and step sizes.
int get_animation_first_frame_number(): get the animation first frame
int get_animation_last_frame_number(): get the animation last frame
int get_animation_step_frame_number(): get the animation step size
DVgeometry& set_current_frame_number(const int): set the current frame
int get_current_frame_number(): get the current frame number
DVgeometry& set_frames_per_second(const float): get and set the frame rate
float get_frames_per_second() const
int compute_animation_size(): determine the size of the animation
int valid_draw_frame(const int frame_num) const: given a frame number, it returns the frame number closest to it that we are allowed to display
int create_display_lists(): generate display lists
void animate_run_forward(): run the animation forward starting from the beginning
void animate_run_backward(): run the animation backward starting from the end
void animate_play_forward(): run the animation forward starting from the current frame
void animate_play_backward(): run the animation backward starting from the current frame
friend void continuous_animate_next(ClientData): continuously animate frames going forward
friend void continuous_animate_next(XtPointer, XtIntervalId *): continuously animate frames going forward
friend void continuous_animate_previous(ClientData): continuously animate frames going backward
friend void continuous_animate_previous(XtPointer, XtIntervalId *): continuously animate frames going backward
int animate_next(): display the next frame--return zero if there is no next frame
int animate_previous(): display the previous frame--return zero if there is no previous frame
void animation_to_start(): display the first frame of the animation set
void animation_to_end(): display the last frame of the animation set
void animation_to_frame(const int frame_num): display the frame given by frame_num.
void animate_stop()
void show_front(): Set the view matrix to show the "front" of the scene.
void show_back(): Set the view matrix to show the "back" of the scene.
void show_top(): Set the view matrix to show the "top" of the scene.
void show_bottom(): Set the view matrix to show the "bottom" of the scene.
void show_left(): Set the view matrix to show the "left" of the scene.
void show_right(): Set the view matrix to show the "right" of the scene.
DVexport_state_type set_export_state(const LCVMstring&)
DVexport_state_type get_export_state(LCVMstring&)
DVexport_state_type get_export_state()
DVrecord_state_type export_start_record(const LCVMstring&, const LCVMstring&)
DVrecord_state_type export_start_record(const DVexport_state_type, const LCVMstring&)
DVrecord_state_type export_pause_record()
DVrecord_state_type export_continue_record()
DVrecord_state_type export_stop_record()
DVrecord_state_type get_record_state()
int animation_draw()
int export_draw()
int export_dataviewer(LCVMstring&): Export the scene in the DataViewer file format.
int export_povary(LCVMstring&): Export the scene as a Povray file (NOT SUPPORTED).
int export_inventor(LCVMstring&): Export the scene as an Inventor file (NOT SUPPORTED).
int export_postscript(LCVMstring&): Export the scene as postscript (NOT SUPPORTED).
int export_ppm(LCVMstring&): Export the scene as a ppm bitmap file.
void set_geometry_pointer(): Set the global dv_current_scene_pointer.
void set_geometry_pointer(DVgeometry*) const: Set the global dv_current_scene_pointer.
void get_name_stack(int x, int y, LCVMstring &name_stack): Return the name_stack of the vertex designated by the give x and y coordinates in the viewport.
void set_perspective(float fov, float ratio, float front_clip, float back_clip): Set the perspective matrix
void get_perspective(float &fov, float &ratio, float &front_clip, float &back_clip): Set the perspective matrix
void set_user_function(int (*func)(DVcreate_image_arguments &)): Set the function which the DVgeometry will use to create the scene graph.
void new_top_level_container(DVcontainer&): Set the top level container to the given container and generate display lists.
DVcontainer& get_top_level_container(): return a reference to the top level container
void reset_named_properties(): reset the named properties so that there are no pre-existing names
void set_default_input_string(LCVMstring&): Set the default_filename.
void get_default_input_string(LCVMstring&) const: Get the default_filename.
void set_default_output_string(LCVMstring&): Set the default output string.
void get_default_output_string(LCVMstring&) const: Get the default output string.
void set_export_filename(LCVMstring&): Set the export_filename.
void get_export_filename(LCVMstring&) const: Get the export_filename.
void set_pick_size(double val): Set the size of pick region.
double get_pick_size(): Get the size of pick region.
void set_persp_angle(double val): Set the size of perspective angle.
double get_persp_angle(): Get the size of perspective angle

Documentation

A toplevel object which provided services such as animation and display list creation. It is the main entry point for DataViewer if you want to use it in retained mode.

Tk_TimerToken timerID

DVnamed_properties named_properties

DVgeometry(int (*)(DVcreate_image_arguments &)=NULL)

Default constructor. It takes as an arguement a function which will create the scene graph which we wish to plot. Note that if a DVgeometry object is created with the function pointer NULL then load_file and read_file and load_file don't actually do anything.

~DVgeometry()

default destuctor

void reset()

initialize

int read_file(char *input_string)

Read a file based on a filename and make a display list

int load_file()

Load a file based on the default filename and make a display list

int draw()

Draw the scene to the current OpenGL drawable. Bascially it calles the display list(s) which contains the compiled version of scene graph. It does not do a swapbuffer on double buffered displays you you need to wrap it in some OpenGL code if you have a double buffered display.

void drawing_area(Tk_Window val)

Set the drawing area widget for the scene

else void drawing_area(Widget val)

Set the drawing area widget for the scene

endif void zoom(float val)

Multiply the current zoom vale by the arguement

void rotate(float *val)

rotate by the new quaternion

void translate(float x, float y)

translate

void get_zoom(float *out)

void get_rotate(float *out)

void get_translate(float *out)

void set_zoom(float *in)

void set_rotate(float *in)

void set_translate(float *in)

float get_zoom()

Return the current zoom value

void useTimer()

Turn on the timer. When the timer is on DVgeometry will print out frames per-second for the current scene

void noTimer()

Turn off the timer

int ifTimer()

Ask is the timer is turned on

void set_background_color(const DVcolor&)

void set_background_color(const LCVMstring&)

void set_background_color(const DVrich_property_item<DVcolor>&)

void set_background_color(const DVexplicit_property_item<DVcolor>&)

void set_background_color(const DVnamed_property_item<DVcolor>&)

int get_animation_optimize_flag() const

Return the value of the animation_optimize_flag. When this flag is true, the DV geometry object will optimized the animation by precomputing a display list for each frame of the animation. This can lead to a LARGE amount of memory usage.

DVgeometry& set_animation_optimize_flag(const int)

Set the value of the animation_optimize_flag

int get_first_frame_number() const

Gets the first frame number. This number is NOT used internally by DVgeometry, it is only provided as information to whatever external program is using the DVgeometry. It should be considered as a hint from the user defined scene graph creation function. Its main use to to allow scene graph creation function to communicate which subset of the animation to draw.

int get_last_frame_number() const

Gets the last frame number. This number is NOT used internally by DVgeometry, it is only provided as information to whatever external program is using the DVgeometry. It should be considered as a hint from the user defined scene graph creation function. Its main use to to allow scene graph creation function to communicate which subset of the animation to draw.

void set_first_frame_number(int)

Sets the first frame number. This number is NOT used internally by DVgeometry, it is only provided as information to whatever external program is using the DVgeometry. It should be considered as a hint from the user defined scene graph creation function. Its main use to to allow scene graph creation function to communicate which subset of the animation to draw.

void set_last_frame_number(int)

Sets the last frame number. This number is NOT used internally by DVgeometry, it is only provided as information to whatever external program is using the DVgeometry. It should be considered as a hint from the user defined scene graph creation function. Its main use to to allow scene graph creation function to communicate which subset of the animation to draw.

DVgeometry& set_animation_frames(const int, const int, const int)

Set the animation first frame, last frame and step sizes. These are the numbers used internally by DVgeometry to compute the bounds of the animation. If animation_optimize_flag is true, this information is used to pre-compute display lists.

int get_animation_first_frame_number()

get the animation first frame

int get_animation_last_frame_number()

get the animation last frame

int get_animation_step_frame_number()

get the animation step size

DVgeometry& set_current_frame_number(const int)

set the current frame

int get_current_frame_number()

get the current frame number

DVgeometry& set_frames_per_second(const float)

get and set the frame rate

float get_frames_per_second() const

int compute_animation_size()

determine the size of the animation

int valid_draw_frame(const int frame_num) const

given a frame number, it returns the frame number closest to it that we are allowed to display

int create_display_lists()

generate display lists

void animate_run_forward()

run the animation forward starting from the beginning

void animate_run_backward()

run the animation backward starting from the end

void animate_play_forward()

run the animation forward starting from the current frame

void animate_play_backward()

run the animation backward starting from the current frame

friend void continuous_animate_next(ClientData)

continuously animate frames going forward

friend void continuous_animate_next(XtPointer, XtIntervalId *)

continuously animate frames going forward

friend void continuous_animate_previous(ClientData)

continuously animate frames going backward

friend void continuous_animate_previous(XtPointer, XtIntervalId *)

continuously animate frames going backward

int animate_next()

display the next frame--return zero if there is no next frame

int animate_previous()

display the previous frame--return zero if there is no previous frame

void animation_to_start()

display the first frame of the animation set

void animation_to_end()

display the last frame of the animation set

void animation_to_frame(const int frame_num)

display the frame given by frame_num.

void animate_stop()

void show_front()

Set the view matrix to show the "front" of the scene.

void show_back()

Set the view matrix to show the "back" of the scene.

void show_top()

Set the view matrix to show the "top" of the scene.

void show_bottom()

Set the view matrix to show the "bottom" of the scene.

void show_left()

Set the view matrix to show the "left" of the scene.

void show_right()

Set the view matrix to show the "right" of the scene.

DVexport_state_type set_export_state(const LCVMstring&)

DVexport_state_type get_export_state(LCVMstring&)

DVexport_state_type get_export_state()

DVrecord_state_type export_start_record(const LCVMstring&, const LCVMstring&)

DVrecord_state_type export_start_record(const DVexport_state_type, const LCVMstring&)

DVrecord_state_type export_pause_record()

DVrecord_state_type export_continue_record()

DVrecord_state_type export_stop_record()

DVrecord_state_type get_record_state()

int animation_draw()

int export_draw()

int export_dataviewer(LCVMstring&)

Export the scene in the DataViewer file format.

int export_povary(LCVMstring&)

Export the scene as a Povray file (NOT SUPPORTED).

int export_inventor(LCVMstring&)

Export the scene as an Inventor file (NOT SUPPORTED).

int export_postscript(LCVMstring&)

Export the scene as postscript (NOT SUPPORTED).

int export_ppm(LCVMstring&)

Export the scene as a ppm bitmap file.

void set_geometry_pointer()

Set the global dv_current_scene_pointer. This is a hack for the Python interface. If there are several DVgeometry objects it points at the last one used.

void set_geometry_pointer(DVgeometry*) const

Set the global dv_current_scene_pointer. This is a hack for the Python interface. If there are several DVgeometry objects it points at the last one used.

void get_name_stack(int x, int y, LCVMstring &name_stack)

Return the name_stack of the vertex designated by the give x and y coordinates in the viewport. In general, each DVcontainer (or other grouping node) will push a new name onto the stack and increment it for each of its children. Also, some compsite nodes (such as DVlines) will push their own names onto the stack. Unfortunately, there is no one place to look for behavior of each class in this regard.

void set_perspective(float fov, float ratio, float front_clip, float back_clip)

Set the perspective matrix

void get_perspective(float &fov, float &ratio, float &front_clip, float &back_clip)

Set the perspective matrix

void set_user_function(int (*func)(DVcreate_image_arguments &))

Set the function which the DVgeometry will use to create the scene graph.

void new_top_level_container(DVcontainer&)

Set the top level container to the given container and generate display lists. NOTE: This routine makes a copy of the given container to create a DVcontainer. So, any special properties of the given container (such as a DVselection_container) will be lost!