All Frameworks  Class Hierarchy  This Framework  Previous  Next  Indexes

SPAkern Class off_spl_sur

SPAbase.ACIS_OBJECT
  |
  +---SPAkern.subtype_object
    |
    +---SPAkern.subtrans_object
      |
      +---SPAkern.spl_sur
        |
        +---off_spl_sur

Usage: you must use this class as is. You should never derive it.

public class off_spl_sur

Represents the offset of a surface.

Role: This class represents the offset of a surface. This is derived from the base class, spl_sur, which is used by the spline surface class to contain the surface description proper. If S(u,v) is the original surface, the offset surface O(u,v) is: O(u,v) = S(u,v) + d* N(u,v) where N(u,v) is the surface normal and d is the offset distance. Along with the benefits of having evaluators based off the offset definition, the off_spl_sur class simplifies offsets of offset surfaces. So, if the user offsets the progenitor surface by some distance (d), and then offsets that surface by the distance (-d), the result is the progenitor surface again. Also, if the progenitor is offset by the distance (d1) and the offset surface is then offset by the distance (d2), the resulting surface is an offset of the progenitor by the distance (d1 + d2).

See also:: surface

Constructor and Destructor Index

o off_spl_sur(off_spl_sur&): C++ copy constructor requests memory for this object and populates it with the data supplied as arguments.
o off_spl_sur(surface&,double,SPApar_box*,logical,logical,logical,logical): C++ initialize constructor requests memory for this object and populates it with the data supplied as arguments.
o off_spl_sur(surface&,double,bs3_surface,double,SPApar_box*,logical,logical): C++ initialize constructor requests memory for this object and populates it with the data supplied as arguments.

Method Index

o deep_copy(pointer_map*): Creates a copy of an item that does not share any data with the original.
o get_approx_offset(): Is the approximation used to evaluate the surface or not.
o get_did_adaptive_offset()
o get_offset_distance(): Returns the offset distance from the surface.
o get_path(): Returns the path used for the offset.
o get_path_type(): Returns the path type used used for the sweep operation.
o get_progenitor(): Returns the progenitor (the surface being offset).
o get_rail(): Returns the rail used for profile orientation in the sweep operation.
o id(): Returns the ID for the off_spl_sur list.
o save_data(): Saves the information for the off_spl_sur to the save file.
o type(): Returns the type of off_spl_sur.
o type_name(): Returns the string "offsur".

Constructor and Destructor

o off_spl_sur

public off_spl_sur( const off_spl_sur& ptr_cpy)

C++ copy constructor requests memory for this object and populates it with the data supplied as arguments.

Parameters:

ptr_cpy: pointer to copy.

o off_spl_sur

public off_spl_sur(	const surface&	`org_surf`,
	double	`offset`,
	const SPApar_box*	`parameter`	`= NULL`,
	logical	`use_approximate_progenitor`	`= FALSE`,
	logical	`subsetted`	`= FALSE`,
	logical	`in_adaptive_offset`	`= FALSE`,
	logical	`did_adaptive_offset`	`= FALSE` )

C++ initialize constructor requests memory for this object and populates it with the data supplied as arguments.

Parameters:

org_surf: original surface.
offset: offset distance.
parameter: parametric box.

o off_spl_sur

public off_spl_sur(	const surface&	`offset_surface`,
	double	`offset`,
	bs3_surface	`approx_bs3`,
	double	`tol`,
	const SPApar_box*	`parameter`	`= NULL`,
	logical	`use_approximate_progenitor`	`= FALSE`,
	logical	`subsetted`	`= FALSE` )

C++ initialize constructor requests memory for this object and populates it with the data supplied as arguments.

Parameters:

offset_surface: surface being offset.
offset: offset distance.
approx_bs3: approximating bs3 surface.
tol: fit tolerance to bs3.
parameter: parameter region.

Methods

o deep_copy

public virtual spl_sur * deep_copy( pointer_map* pm = NULL) const

Creates a copy of an item that does not share any data with the original.

Role: Allocates new storage for all member data and any pointers. Returns a pointer to the copied item.

Parameters:

pm: list of items within the entity that are already deep copied.

o get_approx_offset

public const logical get_approx_offset(

)

Is the approximation used to evaluate the surface or not.

o get_did_adaptive_offset

public logical get_did_adaptive_offset(

)

o get_offset_distance

public double get_offset_distance(

)

Returns the offset distance from the surface.

o get_path

public virtual curve * get_path(

)const

Returns the path used for the offset.

o get_path_type

public virtual sweep_path_type get_path_type(

)const

Returns the path type used used for the sweep operation.

o get_progenitor

public const surface* get_progenitor(

)

Returns the progenitor (the surface being offset).

o get_rail

public virtual law * get_rail(

)const

Returns the rail used for profile orientation in the sweep operation.

o id

public static int id(

)

Returns the ID for the off_spl_sur list.

o save_data

public virtual void save_data(

)const

Saves the information for the off_spl_sur to the save file.

o type

public virtual int type(

)const

Returns the type of off_spl_sur.

o type_name

public virtual char const * type_name(

)const

Returns the string "offsur".

This object is included in the file: off_spl.hxx