All Frameworks  Class Hierarchy  This Framework  Indexes

SPAdefeature Class defeature_options

SPAbase.ACIS_OBJECT
  |
  +---defeature_options

Usage: you can derive this class.

public class defeature_options

Options for local operations.

Role : The defeature_options object fulfills three roles:

It manages the settings for parameters which control whether a particular shape is recognized as a feature (for example, the maximum diameter of holes) and provides reasonable defaults.
It controls whether api_find_and_remove_features() will perform feature recognition, feature removal, or both.
It provides an interface for you to manage and view the features that are to be removed. It provides methods to obtain the number of features recognized and obtain a list of faces corresponding to each feature. It also allows customers to specify features that will not be removed by calling the keep_face() method on any face in the feature. Finally it allows customers to query the number and faces corresponding to features which were marked for removal but not removed (through the failed_feature methods).

In general, the parameters managed by the options object are managed through get_* and "set_* methods. For example, the hole_max_diameter parameter is controlled by the methods get_hole_max_diameter() and set_hole_max_diameter(). Calling a set function without any arguments resets the parameter to its default value.

Constructor and Destructor Index

o defeature_options(): C++ Default constructor requests memory for this object and assigns default values.
o defeature_options(defeature_options&): Copy constructor
o ~defeature_options(): C++ Default destructor

Method Index

o clear_features(): Resets state of the options object to "before recognize", clearing both recognized and failed feature lists.
o clone(): Returns a clone of the object.
o get_blend_supports_max_angle(): Gets the value of the "blend_supoorts_max_angle".
o get_blends_max_radius(): Gets the value of the "blends_max_radius".
o get_blends_num_curvature_samples(): Gets the number of sample curvature points used for testing blends as Constant Radius or Variable Radius blends.
o get_chamfers_max_width(): Gets the value of the "chamfers_max_width".
o get_failed_feature(int,ENTITY_LIST&,defeature_feature_type&): This returns the face list and feature type.
o get_feature(int,ENTITY_LIST&,defeature_feature_type&): This returns the face list and feature type.
o get_hole_max_diameter(): Gets the value of the "hole_max_diameter".
o get_kept_faces(ENTITY_LIST&): Returns a list of faces that were kept and not removed by the feature removal.
o get_num_failed_features(): This returns the number of failed features.
o get_num_features(): This returns the number of recognized features.
o get_pause_after_recognize(): Gets the status of the "pause_after_recognize" flag
o get_recognize_blends(): Gets the status of the "recognize_blends" flag.
o get_recognize_chamfers(): Gets the status of the "recognize_blends" flag to the default value of TRUE.
o get_recognize_holes(): Gets the status of the "recognize_holes" flag.
o get_recognize_sphericalholes(): Gets the status of the "recognize_spherical_holes" flag.
o keep_face(FACE const*,logical): This call lets the user control the defeaturing by marking faces which are required to not be removed.
o kept_face(FACE const*): Queries if a face was kept and not removed by the feature removal.
o operator=(defeature_options&): Assignment operator
o recognize_done(): Returns the status of the "recognize_done" flag.
o remove_done(): Returns the status of the "remove_done" flag.
o set_blend_supports_max_angle(): Sets the value of the "blend_supoorts_max_angle" to the default value of 175 deg.
o set_blend_supports_max_angle(double): Sets the value of the "blend_supoorts_max_angle" to input value in radians.
o set_blends_max_radius(): Sets the value of the "blends_max_radius" to be the default value of 10.
o set_blends_max_radius(double): Sets the value of the "blends_max_radius".
o set_blends_num_curvature_samples(): Sets the number of sample curvature points used for testing blends as Constant Radius or Variable Radius blends to the default value of 1.
o set_blends_num_curvature_samples(int): Sets the number of sample curvature points used for testing blends as Constant Radius or Variable Radius blends to the default value.
o set_chamfers_max_width(): Sets the value of the "chamfers_max_width" to the default value of 10.
o set_chamfers_max_width(double): Sets the value of the "chamfers_max_width" to the input value.
o set_hole_max_diameter(): Sets the value of the "hole_max_diameter" to the default value of 10.
o set_hole_max_diameter(double): Sets the value of the "holes_max_diameter" to the input value.
o set_pause_after_recognize(logical): Sets the status of the "pause_after_recognize" flag.
o set_recognize_blends(): Sets the status of the "recognize_blends" flag to the default value of TRUE.
o set_recognize_blends(logical): Sets the status of the "recognize_blends" flag to the input Value.
o set_recognize_chamfers(): Sets the status of the "recognize_chamfers" flag to the default value of TRUE.
o set_recognize_chamfers(logical): Sets the status of the "recognize_chamfers" flag to the input value.
o set_recognize_holes(): Sets the status of the "recognize_holes" flag to the default value of TRUE.
o set_recognize_holes(logical): Sets the status of the "recognize_holes" flag to the input value.
o set_recognize_sphericalholes(): Sets the status of the "recognize_spherical_holes" flag to the default value of TRUE.
o set_recognize_sphericalholes(logical): Sets the status of the "recognize_spherical_holes" flag to the input value.

Constructor and Destructor

o defeature_options

public defeature_options(

)

C++ Default constructor requests memory for this object and assigns default values.

o defeature_options

protected defeature_options( const defeature_options& copy)

Copy constructor

o ~defeature_options

public ~defeature_options(

)

C++ Default destructor

Methods

o clear_features

public void clear_features(

)

Resets state of the options object to "before recognize", clearing both recognized and failed feature lists.

o clone

public defeature_options* clone(

)const

Returns a clone of the object. The feature data of the defeature_options object is not cloned.

o get_blend_supports_max_angle

public double get_blend_supports_max_angle(

)const

Gets the value of the "blend_supoorts_max_angle". This is the maximum angle between supports of blends that are recognized and removed.

o get_blends_max_radius

public double get_blends_max_radius(

)const

Gets the value of the "blends_max_radius". This value is the maximum radius of the blends that are recognized and removed.

o get_blends_num_curvature_samples

public int get_blends_num_curvature_samples(

)const

Gets the number of sample curvature points used for testing blends as Constant Radius or Variable Radius blends.

o get_chamfers_max_width

public double get_chamfers_max_width(

)const

Gets the value of the "chamfers_max_width". This is the maximum width of the chamfers that are recognized and removed.

o get_failed_feature

public outcome get_failed_feature(	int	`feature_id`,
	ENTITY_LIST&	`feature_faces`,
	defeature_feature_type&	`type`) const

This returns the face list and feature type. This call is valid when feature removal has been completed ("remove_done" is TRUE).

Parameters:

feature_id: Index into the list of failed features.
feature_faces: ENTITY_LIST that will be populated with the list of faces for the feature.
type: defeature_feature_type that will be populated with the type of feature.

o get_feature

public outcome get_feature(	int	`feature_id`,
	ENTITY_LIST&	`feature_faces`,
	defeature_feature_type&	`type`) const

This returns the face list and feature type. This call is valid when feature recognition has been completed ("recognize_done" is TRUE) and feature removal has not been completed ("remove_done" is FALSE).

Parameters:

feature_id: Index into the list of features that were recognized.
feature_faces: ENTITY_LIST that will be populated with the list of faces.
type: defeature_feature_type that will be populated with the type of feature.

o get_hole_max_diameter

public double get_hole_max_diameter(

)const

Gets the value of the "hole_max_diameter". This is the maximum diameter of the holes that are recognized and removed.

o get_kept_faces

public void get_kept_faces( ENTITY_LIST& kept_faces) const

Returns a list of faces that were kept and not removed by the feature removal.

Parameters:

kept_faces: Input ENTITY_LIST that will be populated with the list of Faces.

o get_num_failed_features

public int get_num_failed_features(

)const

This returns the number of failed features. This call is valid when feature removal has been completed ("remove_done" is TRUE).

o get_num_features

public int get_num_features(

)const

This returns the number of recognized features. This call is valid when feature recognition has been completed ("recognize_done" is TRUE) and feature removal has not been completed ("remove_done" is FALSE).

o get_pause_after_recognize

public logical get_pause_after_recognize(

)

Gets the status of the "pause_after_recognize" flag

o get_recognize_blends

public logical get_recognize_blends(

)const

Gets the status of the "recognize_blends" flag.

o get_recognize_chamfers

public logical get_recognize_chamfers(

)const

Gets the status of the "recognize_blends" flag to the default value of TRUE.

o get_recognize_holes

public logical get_recognize_holes(

)const

Gets the status of the "recognize_holes" flag.

o get_recognize_sphericalholes

public logical get_recognize_sphericalholes(

)const

Gets the status of the "recognize_spherical_holes" flag.

o keep_face

public void keep_face(	FACE const*	`feature_face`,
	logical	`keep_it`	`= TRUE`)

This call lets the user control the defeaturing by marking faces which are required to not be removed.

Parameters:

feature_Face: The face on which you would like to set the keep_it flag.
keep_it: logical parameter which tells the defeaturing process to keep a face during feature remval.

o kept_face

public logical kept_face( FACE const* feature_face) const

Queries if a face was kept and not removed by the feature removal.

Parameters:

feature_face: Face for which the query is to be performed.

o operator=

protected defeature_options& operator=( const defeature_options& copy)

Assignment operator

o recognize_done

public logical recognize_done(

)const

Returns the status of the "recognize_done" flag.

o remove_done

public logical remove_done(

)const

Returns the status of the "remove_done" flag.

o set_blend_supports_max_angle

public outcome set_blend_supports_max_angle(

)

Sets the value of the "blend_supoorts_max_angle" to the default value of 175 deg. Can be called only before feature recognition.

o set_blend_supports_max_angle

public outcome set_blend_supports_max_angle( double diameter)

Sets the value of the "blend_supoorts_max_angle" to input value in radians. Can be called only before feature recognition.

o set_blends_max_radius

public outcome set_blends_max_radius(

)

Sets the value of the "blends_max_radius" to be the default value of 10. Can be called only before feature recognition.

o set_blends_max_radius

public outcome set_blends_max_radius( double radius)

Sets the value of the "blends_max_radius". Can be called only before feature recognition.

Parameters:

radius: New value

o set_blends_num_curvature_samples

public outcome set_blends_num_curvature_samples(

)

Sets the number of sample curvature points used for testing blends as Constant Radius or Variable Radius blends to the default value of 1. Can be called only before feature recognition.

o set_blends_num_curvature_samples

public outcome set_blends_num_curvature_samples( int numSamples)

Sets the number of sample curvature points used for testing blends as Constant Radius or Variable Radius blends to the default value. Can be called only before feature recognition.

Parameters:

numSamples: New Value

o set_chamfers_max_width

public outcome set_chamfers_max_width(

)

Sets the value of the "chamfers_max_width" to the default value of 10. Can be called only before feature recognition.

o set_chamfers_max_width

public outcome set_chamfers_max_width( double width)

Sets the value of the "chamfers_max_width" to the input value. Can be called only before feature recognition.

Parameters:

width: New Value.

o set_hole_max_diameter

public outcome set_hole_max_diameter(

)

Sets the value of the "hole_max_diameter" to the default value of 10. Can be called only before feature recognition.

o set_hole_max_diameter

public outcome set_hole_max_diameter( double diameter)

Sets the value of the "holes_max_diameter" to the input value. Can be called only before feature recognition.

Parameters:

diameter: New Value.

o set_pause_after_recognize

public outcome set_pause_after_recognize( logical flag)

Sets the status of the "pause_after_recognize" flag. Can be called only before feature recognition.

Parameters:

flag: NewValue

o set_recognize_blends

public outcome set_recognize_blends(

)

Sets the status of the "recognize_blends" flag to the default value of TRUE. Can be called only before feature recognition.

o set_recognize_blends

public outcome set_recognize_blends( logical flag)

Sets the status of the "recognize_blends" flag to the input Value.Can be called only before feature recognition.

Parameters:

flag: New value

o set_recognize_chamfers

public outcome set_recognize_chamfers(

)

Sets the status of the "recognize_chamfers" flag to the default value of TRUE.

o set_recognize_chamfers

public outcome set_recognize_chamfers( logical flag)

Sets the status of the "recognize_chamfers" flag to the input value.

Parameters:

flag: New Value

o set_recognize_holes

public outcome set_recognize_holes(

)

Sets the status of the "recognize_holes" flag to the default value of TRUE. This can be called only before feature recognition.

o set_recognize_holes

public outcome set_recognize_holes( logical flag)

Sets the status of the "recognize_holes" flag to the input value. This can be called only before feature recognition.

Parameters:

flag: New Value.

o set_recognize_sphericalholes

public outcome set_recognize_sphericalholes(

)

Sets the status of the "recognize_spherical_holes" flag to the default value of TRUE.

o set_recognize_sphericalholes

public outcome set_recognize_sphericalholes( logical flag)

Sets the status of the "recognize_spherical_holes" flag to the input value.

Parameters:

flag: New Value

This object is included in the file: acis_defeature_options.hxx