Home

DM_lct_icon Class Reference
[Interactive Graphics Interface]

This class is used for drawing curve link constraint tag objects in deformable modeling. More...

#include <dmlcticon.hxx>

Inheritance diagram for DM_lct_icon:

Inheritance graph
[legend]
Collaboration diagram for DM_lct_icon:

Collaboration graph
[legend]

List of all members.

Public Member Functions

 DM_lct_icon ()
 Public constructor.
virtual void Draw (Spatial_abs_hurler &err_handler, const DM_icon_draw_args &draw_obj) const
 Draws this icon.
virtual void Get_colors (DM_dbl_array &arr_data) const
 Queries color data.
virtual int Get_draw_option () const
 Returns the current draw option filter settings.
virtual void Get_grid (int density[2]) const
 Queries discretization grid density.
virtual double Get_icon_width () const
 Returns the icon width.
virtual int Get_on_off () const
 Returns the current on or off state.
virtual void Get_owner (DS_dmod *&dmod, int &tag) const
 Icon owner query.
virtual void Invalidate ()
 Marks cached data bad.
virtual int Is_valid () const
 Returns TRUE if the cache has not been invalidated.
virtual void Lose ()
 Public destructor.
virtual DM_iconMake_copy (Spatial_abs_hurler &err_handler) const
 Clone method.
virtual void Query (Spatial_abs_hurler &err_handler, DM_icon_query_args &query_obj) const
 Queries and returns the result in query_obj.
virtual void Set_colors (const double *col_data, int arr_size)
 Sets color data.
virtual void Set_draw_option (int option)
 Sets filter to draw seams, constraints and/or loads.
virtual void Set_grid (const int density[2])
 Sets discretization grid density.
virtual void Set_icon_width (double width)
 Sets the icon draw width.
virtual void Set_on_off (int on_off)
 Sets the on or off state.
virtual void Set_owner (Spatial_abs_hurler &err_handler, DS_dmod *new_dmod, int new_tag)
 This routine is called by DM to inform the icon of the DS_dmod pointer and tag ID of its owning tag object.
virtual void Set_state (Spatial_abs_hurler &err_handler, const DM_icon_cmd_args &cmd_obj)
 Tells icon to execute the command encapsulated in cmd_obj on itself, if applicable.
virtual void Tag_object_changed (Spatial_abs_hurler &err_handler)
 Notification of owning tag object state change.
virtual void Validate ()
 Updates cached data.

Protected Member Functions

 DM_lct_icon (const DM_lct_icon &)
 Copy constructor.


Detailed Description

This class is used for drawing curve link constraint tag objects in deformable modeling.


Role: The DM_lct_icon is part of the dmicon library. This icon updates a polyline to depict the current state of a curve link constraint.

Related classes
The DM_def_icon_cmd_args and the DM_def_icon_query_args encapsulate many of the methods inherited from the DM_default_icon interface. Thus the Set_state and Query methods can be used to perform casting, when different libraries of icons are mixed.

The DM_def_icon_draw_args and the DM_def_icon_cmd_args can be broadcast to icons using the deformable modeling interface methods, such as DM_draw_all_icons.

See also:
DM_dbl_array

Constructor & Destructor Documentation

DM_lct_icon::DM_lct_icon ( const DM_lct_icon  )  [protected]

Copy constructor.



Role: Should not call copy contructor; call Make_copy and Set_owner instead.

DM_lct_icon::DM_lct_icon (  ) 

Public constructor.


Member Function Documentation

virtual void DM_lct_icon::Draw ( Spatial_abs_hurler err_handler,
const DM_icon_draw_args draw_obj 
) const [virtual]

Draws this icon.



Parameters:
err_handler error handler.
draw_obj draw-command object.

Implements DM_icon.

virtual void DM_lct_icon::Get_colors ( DM_dbl_array arr_data  )  const [virtual]

Queries color data.



Parameters:
arr_data data array.

Reimplemented from DM_default_icon.

virtual int DM_default_icon::Get_draw_option (  )  const [virtual, inherited]

Returns the current draw option filter settings.

virtual void DM_lct_icon::Get_grid ( int  density[2]  )  const [virtual]

Queries discretization grid density.



Parameters:
density density.

Reimplemented from DM_default_icon.

virtual double DM_default_icon::Get_icon_width (  )  const [virtual, inherited]

Returns the icon width.

virtual int DM_default_icon::Get_on_off (  )  const [virtual, inherited]

Returns the current on or off state.

virtual void DM_default_icon::Get_owner ( DS_dmod *&  dmod,
int &  tag 
) const [virtual, inherited]

Icon owner query.



Parameters:
dmod icon owner dmod.
tag icon owner tag ID.

Implements DM_icon.

virtual void DM_default_icon::Invalidate (  )  [virtual, inherited]

Marks cached data bad.

Reimplemented in ADM_srf_icon, ADM_srf_icon2, ADM_srf_icon3, DM_act_icon, DM_crv_icon, DM_dpr_icon, and DM_srf_icon.

virtual int DM_default_icon::Is_valid (  )  const [virtual, inherited]

Returns TRUE if the cache has not been invalidated.

virtual void DM_default_icon::Lose (  )  [virtual, inherited]

Public destructor.

To ensure that the same library allocates and deallocates the memory for icons, icons are destructed by calling their lose method, which in turn should call the C++ destructor.

Implements DM_icon.

virtual DM_icon* DM_lct_icon::Make_copy ( Spatial_abs_hurler err_handler  )  const [virtual]

Clone method.



Parameters:
err_handler error handler.

Implements DM_icon.

virtual void DM_default_icon::Query ( Spatial_abs_hurler err_handler,
DM_icon_query_args query_obj 
) const [virtual, inherited]

Queries and returns the result in query_obj.



Parameters:
err_handler error handler.
query_obj query object.

Implements DM_icon.

virtual void DM_lct_icon::Set_colors ( const double *  col_data,
int  arr_size 
) [virtual]

Sets color data.



Parameters:
col_data color data (r,g,b).
arr_size array size, number of doubles.

Reimplemented from DM_default_icon.

virtual void DM_default_icon::Set_draw_option ( int  option  )  [virtual, inherited]

Sets filter to draw seams, constraints and/or loads.



Parameters:
option option.

Reimplemented in ADM_srf_icon, ADM_srf_icon2, ADM_srf_icon3, DM_act_icon, DM_crv_icon, DM_dpr_icon, and DM_srf_icon.

virtual void DM_lct_icon::Set_grid ( const int  density[2]  )  [virtual]

Sets discretization grid density.



Parameters:
density density.

Reimplemented from DM_default_icon.

virtual void DM_default_icon::Set_icon_width ( double  width  )  [virtual, inherited]

Sets the icon draw width.



Parameters:
width width.

Reimplemented in ADM_srf_icon, ADM_srf_icon2, ADM_srf_icon3, DM_act_icon, DM_crv_icon, DM_dpr_icon, and DM_srf_icon.

virtual void DM_default_icon::Set_on_off ( int  on_off  )  [virtual, inherited]

Sets the on or off state.



Parameters:
on_off state.

virtual void DM_default_icon::Set_owner ( Spatial_abs_hurler err_handler,
DS_dmod new_dmod,
int  new_tag 
) [virtual, inherited]

This routine is called by DM to inform the icon of the DS_dmod pointer and tag ID of its owning tag object.

These can then be used in DM interface query functions to allow the icon to determine the state of its owning tag object. During creation of a new tag object, this routine will not be called until the owning tag object has been completely initialized and is safe to be queried. This routine should not be called by customer code.

Parameters:
err_handler error handler.
new_dmod icon owner dmod.
new_tag icon owner tag ID.

Implements DM_icon.

Reimplemented in ADM_srf_icon, ADM_srf_icon2, ADM_srf_icon3, DM_act_icon, DM_crv_icon, DM_dpr_icon, DM_pct_icon, and DM_srf_icon.

virtual void DM_default_icon::Set_state ( Spatial_abs_hurler err_handler,
const DM_icon_cmd_args cmd_obj 
) [virtual, inherited]

Tells icon to execute the command encapsulated in cmd_obj on itself, if applicable.



Parameters:
err_handler error handler.
cmd_obj command object.

Implements DM_icon.

virtual void DM_lct_icon::Tag_object_changed ( Spatial_abs_hurler err_handler  )  [virtual]

Notification of owning tag object state change.



Parameters:
err_handler error handler.

Implements DM_icon.

virtual void DM_lct_icon::Validate (  )  [virtual]

Updates cached data.

Implements DM_default_icon.