Dtk_feat_user_pattern Class Reference

Public Member Functions
	Dtk_feat_user_pattern ()
int	get_anchor_point (Dtk_feat_geometry **)
	Returns the anchor point of the user pattern feature. More...
int	get_features (Dtk_tab< Dtk_FeaturePtr > &)
	Returns the array of features resulted of the user pattern feature. More...
int	get_gener_tool (bool *)
	Returns the generated tool status indicating if generated features are to be gotten. More...
int	get_input_ids (Dtk_tab< long > &)
	Returns the array of Feature's IDs or Body ID to user pattern feature. More...
int	get_keep_spec (Bool *)
	Returns the design intent of the user pattern (keeping specifications). More...
int	get_nb_features (int *)
	Returns the number of features resulted of the user pattern feature. More...
int	get_nb_input_ids (int *)
	Returns the number of feature's IDs to user pattern feature. More...
int	get_nb_points (int *)
	Returns the number of points to user pattern. More...
int	get_object_to_pattern (Dtk_feat_geometry **)
	Returns the geometry of the object to pattern to pattern. More...
int	get_points (Dtk_tab< Dtk_pnt > &)
	Returns the points to user pattern. More...
	~Dtk_feat_user_pattern ()

Data Fields
Dtk_feat_geometry *	anchor_point
Dtk_tab< Dtk_FeaturePtr >	dtk_features
bool	gener_tool
Dtk_tab< long >	input_ids
Bool	keep_spec
Dtk_feat_geometry *	object_to_pattern
DTK_OBJECT_TYPE	object_type
Dtk_tab< Dtk_pnt >	points
Dtk_feat_sketch *	sketch

Constructor & Destructor Documentation

Dtk_feat_user_pattern()

Dtk_feat_user_pattern::Dtk_feat_user_pattern

(

)

~Dtk_feat_user_pattern()

Dtk_feat_user_pattern::~Dtk_feat_user_pattern

(

)

Member Function Documentation

get_anchor_point()

int Dtk_feat_user_pattern::get_anchor_point

(

Dtk_feat_geometry **

)

Returns the anchor point of the user pattern feature.

Parameters

[in]	User	Pattern Feature
	[in/out]
[out]	Dtk_feat_geometry	*

Returns

NOTOK if error, ISOK if ok

Remarks

get_features()

int Dtk_feat_user_pattern::get_features

(

Dtk_tab< Dtk_FeaturePtr > &

)

Returns the array of features resulted of the user pattern feature.

Parameters

[in]	User	Pattern Feature
	[in/out]
[out]	Dtk_feat	**

Returns

NOTOK if error, ISOK if ok

Remarks

get_gener_tool()

int Dtk_feat_user_pattern::get_gener_tool

(

bool *

)

Returns the generated tool status indicating if generated features are to be gotten.

Parameters

[in]	User	Pattern Feature
	[in/out]
[out]	bool

Returns

NOTOK if error, ISOK if ok

Remarks

get_input_ids()

int Dtk_feat_user_pattern::get_input_ids

(

Dtk_tab< long > &

)

Returns the array of Feature's IDs or Body ID to user pattern feature.

Parameters

[in]	User	Pattern Feature
	[in/out]
[out]	long	* (Array of IDs, size = nb_input_ids)

Returns

NOTOK if error, ISOK if ok

Remarks

get_keep_spec()

int Dtk_feat_user_pattern::get_keep_spec

(

Bool *

)

Returns the design intent of the user pattern (keeping specifications).

Parameters

[in]	User	Pattern Feature
	[in/out]
[out]	Bool

Returns

NOTOK if error, ISOK if ok

Remarks

get_nb_features()

int Dtk_feat_user_pattern::get_nb_features

(

int *

)

Returns the number of features resulted of the user pattern feature.

Parameters

[in]	User	Pattern Feature
	[in/out]
[out]	int

Returns

NOTOK if error, ISOK if ok

Remarks

get_nb_input_ids()

int Dtk_feat_user_pattern::get_nb_input_ids

(

int *

)

Returns the number of feature's IDs to user pattern feature.

Parameters

[in]	User	Pattern Feature
	[in/out]
[out]	int

Returns

NOTOK if error, ISOK if ok

Remarks

get_nb_points()

int Dtk_feat_user_pattern::get_nb_points

(

int *

)

Returns the number of points to user pattern.

Parameters

[in]	User	Pattern Feature
	[in/out]
[out]	int	* (number of points)

Returns

NOTOK if error, ISOK if ok

Remarks

get_object_to_pattern()

int Dtk_feat_user_pattern::get_object_to_pattern

(

Dtk_feat_geometry **

)

Returns the geometry of the object to pattern to pattern.

Parameters

[in]	User	Pattern Feature
	[in/out]
[out]	Dtk_feat_geometry	*

Returns

NOTOK if error, ISOK if ok

Remarks

get_points()

int Dtk_feat_user_pattern::get_points

(

Dtk_tab< Dtk_pnt > &

)

Returns the points to user pattern.

Parameters

[in]	User	Pattern Feature
	[in/out]
[out]	Dtk_pnt	* (Array of points)

Returns

NOTOK if error, ISOK if ok

Remarks

Field Documentation

anchor_point

Dtk_feat_geometry* Dtk_feat_user_pattern::anchor_point

dtk_features

Dtk_tab<Dtk_FeaturePtr> Dtk_feat_user_pattern::dtk_features

gener_tool

bool Dtk_feat_user_pattern::gener_tool

input_ids

Dtk_tab<long> Dtk_feat_user_pattern::input_ids

keep_spec

Bool Dtk_feat_user_pattern::keep_spec

object_to_pattern

Dtk_feat_geometry* Dtk_feat_user_pattern::object_to_pattern

object_type

DTK_OBJECT_TYPE Dtk_feat_user_pattern::object_type

points

Dtk_tab<Dtk_pnt> Dtk_feat_user_pattern::points

sketch

Dtk_feat_sketch* Dtk_feat_user_pattern::sketch