class DVframed

class DVframed_lines: public DVlines

A class for rendering curves in space.

Inheritance:

Public Methods
DVframed_lines( const float x0=0.0, const float y0=0.0, const float z0=0.0, const float x1=1.0, const float y1=0.0, const float z1=0.0 ): the end points of the line segment are given default line starts at the origin, proceeds along the positive x-axis and has length one.
DVframed_lines( const float x0, const float y0, const float z0, const float d0, const float d1, const float d2, const float x1, const float y1, const float z1, const float e0, const float e1, const float e2 ): for giving a ribbon segment.
DVframed_lines(LCVMarray_2D<float> &coords): The coordinates of the points for one line are stored in the array coords.
DVframed_lines(LCVMarray_3D<float> &coords): The coordinates of the points for several lines are in the array coords.
void set_defaults(): Set what has to be rendered by default: no frame, no ribbon, mirrored ribbon, and surface ribbon
virtual ~DVframed_lines(): destructor
virtual void draw(LCVMstack<DVproperty*>&): main draw routine
void draw_ribbons(LCVMstack<DVproperty*> &): It draws the whole list of ribbons.
void draw_frames(LCVMstack<DVproperty*>&): Draws the frame.
void draw_ribbon(LCVMstack<DVproperty*> &): Draws the current ribbon. It should not be called directly.
void draw_plain_ribbon(LCVMstack<DVproperty*> &): Draws one ribbon as a surface.
void draw_vector_ribbon(LCVMstack<DVproperty*> &): Draws one ribbon as a vector field.
DVframed_lines(DVframed_lines &data): We also want a copy constructor as well as an assignment operator
int copy_ribbons(DVframed_lines &data): Copies the list of ribbons.
const DVframed_lines& operator=(DVframed_lines &data): Assignment operator
int operator==(DVframed_lines &data): check for equality
int operator!=(DVframed_lines &data): Check for not equality
DVframed_lines& set_frame_status(const DVframed_lines_frame_status): Set the frame status
DVframed_lines& set_ribbon_form_status(const DVribbon_form_status): Choose between surface or vector field ribbon.
DVframed_lines& set_ribbon_mirror_status(const DVribbon_mirror_status): Choose between one sided and mirrored ribbon.
int add_ribbon(int, int, int): Adds a ribbon to the list, x,y and z coordinates given.
int add_ribbon(int, int, int, int): Adds a ribbon to the list, x,y and z and color coordinates given.
int add_ribbon(LCVMarray<int> *new_ribbon): Adds a ribbon from an array of coordinates.
int add_ribbon(LCVMarray<int> &): Adds a ribbon from an array of coordinates
int set_ribbon(int, int, int, int): Sets the current ribbon coordinates
int set_ribbon(LCVMarray<int> &): Sets the current ribbon coordinates
void default_frame_coords(): Sets the default frame with the coordinates: 3 to 9 for the x,y,z coordinates, 10 to 12 for the color
void set_frame_coords(int d1x, int d1y, int d1z, int d2x, int d2y, int d2z, int d3x, int d3y, int d3z): Set the frame coordinates, color not given.
void set_frame_coords(int d1x, int d1y, int d1z, int d2x, int d2y, int d2z, int d3x, int d3y, int d3z, int color1, int color2, int color3): Set the frame coordinates, including the color.
void set_frame_coords(LCVMarray_2D<int> &coords): Set the frame coordinates from an array.
DVframed_lines_frame_status get_frame_status(): Get the frame status
int get_ribbon_number(): Get the number of ribbons in the list.
void set_coord_names(LCVMarray<LCVMstring> &the_names): Set the coordinates names from an LCVMarray, no size needed.
void set_coord_names(char **the_names, int coord_nr): Set the coordinates names from a usual array, its size is needed.
LCVMstring get_coord_name(int coord_nr): Get the name of the coordinate specified by a number.
const char* get_char_coord_name(int coord_nr): Get the name of the coordinate specified by a number.
int get_coords_number(LCVMstring &a_name): Get the number of the coordinate with the given name.
int get_coords_number(char *a_name): Get the number of the coordinate with the given name.
virtual void print(ostream&): a virtual print function
friend ostream& operator<<(ostream &, DVframed_lines &): A friend routine to overload the << operator
DVframed_lines(FileOption a_file_op): constructor from the global file with a file format option
void ReadVBMoptions(): Read the options generated by VBM and in the VBM style
void ReadRibbonDef(): Read the ribbon coordinates in the VBM style
void ReadSomeCoords(int *where, const int n, const int def_val = 0): Read the coordinates in the VBM style
void ReadDefaults(): Read the default coordinates in the VBM style
void ReadCoordDef(): Read the default coordinates in the VBM style, no color given
void ReadFrameDef(): Read the frame in the VBM style
void ReadFrameColorDef(): Read the frame plus its color in the VBM style
virtual int ReadMyProp(): Specific properties for the scene file format.

Protected Fields
DVframed_lines_frame_status frame_status: Tells if the frame is drawn or not.
int ribbon_number: The number of ribbons to be drawn.
LCVMarray_2D<int> frame_coords: The coordinates of the frame.
LCVMarray<LCVMstring> coord_names: The names of all used coordinates.
LCVMdoubly_linked_list<LCVMarray<int> *> ribbons: A list of coordinate vectors (3) for the ribbons
DVribbon_form_status form_status: Tells if the ribbon is rendered as a surface or as a vector.
DVribbon_mirror_status mirror_status: Tells if the ribbon is on one or on two sides of the line.

Protected Methods
virtual DVobject* copy(): We also want a routine that returns a pointer to a copy of the object created with new

Inherited from DVlines:

Public Methods
DVlines& set_data( const float x0=0.0, const float y0=0.0, const float z0=0.0, const float x1=1.0, const float y1=0.0, const float z1=0.0 )
DVlines& set_data( const float x0, const float y0, const float z0, const float d0, const float d1, const float d2, const float x1, const float y1, const float z1, const float e0, const float e1, const float e2 )
DVlines& set_data(LCVMarray_2D<float> &coords)
DVlines& set_data(LCVMarray_3D<float> &coords)
void draw_lines(LCVMstack<DVproperty*>&)
void draw_cylinders(LCVMstack<DVproperty*>&)
DVlines& set_line_status(const DVlines_line_status)
DVlines& set_ribbon_status(const DVlines_ribbon_status)
DVlines_line_status get_line_status()
DVlines_ribbon_status get_ribbon_status()
DVlines& set_data(FileOption a_file_op)

Protected Fields
DVlines_line_status line_status
DVlines_ribbon_status ribbon_status

Inherited from DVpoints_2D:

Public Methods
void get_used_coordinates(LCVMarray_3D<float>&, const int select=0)
void get_used_coordinates(LCVMarray_3D<float>&, DVscale &, const int select=0)
void get_used_colors(LCVMarray_2D<float>&, const int select=0)
void ReadDVProps()

Protected Fields
LCVMarray_3D<float> points

Inherited from DVobject:

Public Methods
DVobject& set_translate(LCVMarray<float> &data)
DVobject& set_translate(const float x, const float y, const float z)
DVobject& add_translate(LCVMarray<float> &data)
DVobject& add_translate(const float x, const float y, const float z)
DVobject& set_rotate(LCVMarray<float> &data, const float angle, const char type='d')
DVobject& set_rotate( const float x, const float y, const float z, const float angle, const char type='d' )
DVobject& add_rotate(LCVMarray<float> &data, const float angle, const char type='d')
DVobject& add_rotate( const float x, const float y, const float z, const float angle, const char type='d' )
void get_translation(LCVMarray<float>&)
void get_rotation(LCVMarray<float>&, float&)
void set_OpenGL_lighting_properties(DVlight_properties_property_item_array &lights)
void set_OpenGL_material_properties(DVmaterial_properties_property_item &material, DVcolor &color)
void set_OpenGL_color(DVcolor &color)
virtual DVobject& copy_child(DVobject &child)
virtual DVobject& delete_current_child()
int ReadProp()
void ReadDVrotate()
void ReadDVtranslation()
void ReadSimpleProps()

Public

Protected Fields
class DVcontainerbase LCVMarray<float> translation
LCVMarray<float> rotation_axis
float rotation_angle
LCVMarray<float> rotation_quaterions

Protected Methods
void axis_to_quat(LCVMarray<float> axis, float angle, LCVMarray<float> &quat)
void quat_to_axis(LCVMarray<float> quat, LCVMarray<float> &axis, float &angle)
void add_quat(LCVMarray<float> a, LCVMarray<float> b, LCVMarray<float> &c)

Inherited from DVselect_property:

Public Fields
DVcolor_select_property_item_array color
DVpositive_float_select_property_item_array width
DVcomplexity_int_select_property_item geometry_complexity
DVcomplexity_int_select_property_item light_complexity
DVscale_select_property_item scale
DVcolor_by_data_select_property_item_array color_by_data
DVrich_light_properties_select_property_item_array lights
DVrich_material_properties_select_property_item_array material

Public Methods
void extract_properties(DVproperty&)
void default_lighting()
void ReadDVColor()
void ReadDVlightComp()
void ReadDVgeomComp()
void ReadDVscale()
void ReadDVwidth()
void ReadColorMap()

Inherited from DVpick_components:

Public Methods
void set_x_plot_coordinate(const int i, const int select=0)
void set_y_plot_coordinate(const int j, const int select=0)
void set_z_plot_coordinate(const int k, const int select=0)
void set_plot_coordinate(const int i, const int coord, const int select=0)
void set_xyz_plot_coordinates(const int i, const int j, const int k, const int select=0)
void set_xyz_plot_coordinates(LCVMarray<int> &i, const int select=0)
void set_xyz_plot_coordinates(LCVMarray_2D<int> &i)
void set_color_coordinate(const int i, const int select=0)
void set_color_coordinates(LCVMarray<int> &i)
int check_color_coordinates(int select = 0)
int ReadPickCompProp()
void ReadCoords()
void ReadColorCoord()

Protected Fields
int num_elts
LCVMarray_2D<int> use_xyz
LCVMarray<int> use_color

Protected Methods
void default_use_coords()
void default_use_colors()
void check_use_coords()
void check_use_colors()

Documentation

A class for rendering curves in space. It can render a group of space curves, using either lines or cylinders. Compared to the DVlines class from which it is derived, this class can place several director fields or ribbons along the center line. The ribbons can be either vectors or surfaces, and on one or both sides of the line.

DVframed_lines_frame_status frame_status

Tells if the frame is drawn or not.