Home

detect_feature_options Class Reference
[detect feature]

Options for feature detection and blend detection. More...

#include <detect_feature_opts.hxx>

Inheritance diagram for detect_feature_options:

Inheritance graph
[legend]
Collaboration diagram for detect_feature_options:

Collaboration graph
[legend]

List of all members.

Public Member Functions

detect_blend_optionsdetect_blend_opts ()
 This method returns handle of detect_blend_options only when add_periphery_blends is set to true.
 detect_feature_options (double smoothness_allowance=-1.0, bool add_periphery_blends=true)
 C++ allocation constructor requests memory for this object but does not populate it.
virtual AcisJournalget_journal ()
 This method returns the AcisJournal value.
virtual AcisVersionget_version ()
 This method returns the AcisVersion value.
logical journal_on ()
 This method returns TRUE if the journal is enabled and the specified component is set to be journaled, Otherwise it returns FALSE.
void set_acis_options (AcisOptions *ao)
 This method facilitates accommodation of existing AcisOptions if any, in the detect feature options.
virtual void set_journal (AcisJournal &journalInfo)
 This method sets the value of AcisJournal to the value of the passed AcisJournal object.
virtual void set_version (AcisVersion const &version)
 This method sets the value of AcisVersion of the AcisOptions object to the value of the passed AcisVersion object.
virtual ~detect_feature_options ()
 C++ default destructor.


Detailed Description

Options for feature detection and blend detection.


Role: This class contains information to be used to control the behaviour of feature detection involved in api_detect_blends, api_detect_protrusion, api_detect_depression.



add_periphery_blends Add periphery blends. Flag to control whether the blends situated at boundary of depression or protrusion feature are to be included in the list of feature faces. The default value of this option is TRUE, hence periphery blends are included in the return list.
smoothness_allowance Edge smoothness allowance. This is used for determining smoothness of an edge of a feature-face. The value of this allowance decides the threshold of the sine value of the angle between the normals of the faces shared by a smooth edge.
detect_blend_options Options to control the detection of blends.


Constructor & Destructor Documentation

detect_feature_options::detect_feature_options ( double  smoothness_allowance = -1.0,
bool  add_periphery_blends = true 
)

C++ allocation constructor requests memory for this object but does not populate it.

When add_periphery_blends is set true, detect_blend_options object is constructed internally.

virtual detect_feature_options::~detect_feature_options (  )  [virtual]

C++ default destructor.


Member Function Documentation

detect_blend_options* detect_feature_options::detect_blend_opts (  ) 

This method returns handle of detect_blend_options only when add_periphery_blends is set to true.

Otherwise, the return value is NULL. Fetching detect_blend_options allows user to specify the periphery blend face properties.

virtual AcisJournal& AcisOptions::get_journal (  )  [virtual, inherited]

This method returns the AcisJournal value.

virtual AcisVersion& AcisOptions::get_version (  )  [virtual, inherited]

This method returns the AcisVersion value.

logical AcisOptions::journal_on (  )  [inherited]

This method returns TRUE if the journal is enabled and the specified component is set to be journaled, Otherwise it returns FALSE.

void detect_feature_options::set_acis_options ( AcisOptions ao  ) 

This method facilitates accommodation of existing AcisOptions if any, in the detect feature options.

virtual void AcisOptions::set_journal ( AcisJournal journalInfo  )  [virtual, inherited]

This method sets the value of AcisJournal to the value of the passed AcisJournal object.



Parameters:
journalInfo journal.

virtual void AcisOptions::set_version ( AcisVersion const &  version  )  [virtual, inherited]

This method sets the value of AcisVersion of the AcisOptions object to the value of the passed AcisVersion object.



Parameters:
version version.