Data Structures
union	dtk_pattern_type

Public Member Functions
	Dtk_feat_pattern ()

int	get_active_instances (Bool **)
	Returns the array of boolean values to determine an occurrence to be set active or inactive. More...

int	get_angle (double *)
	Returns the rotation angle specified to the pattern feature. More...

int	get_circ_pattern (Dtk_feat_circ_pattern **)
	Returns the circular entity of the pattern feature. More...

int	get_features (Dtk_tab< Dtk_FeaturePtr > &)
	Returns the array of features resulted of the 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 pattern. More...

int	get_keep_spec (Bool *)
	Returns the design intent of the pattern (keeping specifications). More...

int	get_nb_features (int *)
	Returns the number of features resulted of the pattern feature. More...

int	get_nb_input_ids (int *)
	Returns the number of feature's IDs to pattern. More...

int	get_nb_instances (int *)
	Returns the number of whole instances generated by the pattern feature . More...

int	get_nb_objects_to_pattern (int *)
	Returns the number of objects to pattern. More...

int	get_object_type (DTK_OBJECT_TYPE *)
	Returns object type More...

int	get_objects_to_pattern (Dtk_tab< Dtk_feat_geometry * > &)
	Returns the set of objects geometry to pattern. More...

int	get_rect_pattern (Dtk_feat_rect_pattern **)
	Returns the rectangular entity of the pattern feature. More...

int	get_row1 (int *)
	Returns the order of the base feature in the list of occurrences resulted of the pattern feature. More...

int	get_row2 (int *)
	Returns the order of the base feature in the list of occurrences resulted of the pattern feature. More...

int	get_simple_rep (Bool *)
	Returns a boolean value indicating whether some inactive occurrences are set. More...

int	get_type (DTK_PATTERN_TYPE *)
	Returns pattern type More...

	~Dtk_feat_pattern ()

Data Fields
Bool *	active_instances

double	angle

Dtk_tab< Dtk_FeaturePtr >	dtk_features

union Dtk_feat_pattern::dtk_pattern_type	entity

bool	gener_tool

Dtk_tab< long >	input_ids

Bool	keep_spec

int	nb_instances

DTK_OBJECT_TYPE	object_type

Dtk_tab< Dtk_transfo >	objects_placement

Dtk_tab< Dtk_feat_geometry * >	objects_to_pattern

int	row1

int	row2

Bool	simple_rep

DTK_PATTERN_TYPE	type

Constructor & Destructor Documentation

◆ Dtk_feat_pattern()

Dtk_feat_pattern::Dtk_feat_pattern ( )

◆ ~Dtk_feat_pattern()

Dtk_feat_pattern::~Dtk_feat_pattern ( )

Member Function Documentation

◆ get_active_instances()

int Dtk_feat_pattern::get_active_instances ( Bool ** )

Returns the array of boolean values to determine an occurrence to be set active or inactive.

Parameters

[in]	Pattern	Feature
	[in/out]
[out]	Bool	* (size of the array = nb_instances)

Returns: NOTOK if error, ISOK if ok

Remarks

◆ get_angle()

int Dtk_feat_pattern::get_angle ( double * )

Returns the rotation angle specified to the pattern feature.

Parameters

[in]	Pattern	Feature
	[in/out]
[out]	double

Returns: NOTOK if error, ISOK if ok

Remarks: For Circular Pattern : It represents an additional distance between the base feature to pattern and the first occurrence among the repetitions. For Rectangular Pattern : It represents the angle of deviation of the pattern according to its first direction

◆ get_circ_pattern()

int Dtk_feat_pattern::get_circ_pattern ( Dtk_feat_circ_pattern ** )

Returns the circular entity of the pattern feature.

Parameters

[in]	Pattern	Feature
	[in/out]
[out]	Dtk_feat_circ_pattern*

Returns: NOTOK if error, ISOK if ok

Remarks

◆ get_features()

int Dtk_feat_pattern::get_features ( Dtk_tab< Dtk_FeaturePtr > & )

Returns the array of features resulted of the pattern feature.

Parameters

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

Returns: NOTOK if error, ISOK if ok

Remarks

◆ get_gener_tool()

int Dtk_feat_pattern::get_gener_tool ( bool * )

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

Parameters

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

Returns: NOTOK if error, ISOK if ok

Remarks

◆ get_input_ids()

int Dtk_feat_pattern::get_input_ids ( Dtk_tab< long > & )

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

Parameters

[in]	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_pattern::get_keep_spec ( Bool * )

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

Parameters

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

Returns: NOTOK if error, ISOK if ok

Remarks

◆ get_nb_features()

int Dtk_feat_pattern::get_nb_features ( int * )

Returns the number of features resulted of the pattern feature.

Parameters

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

Returns: NOTOK if error, ISOK if ok

Remarks

◆ get_nb_input_ids()

int Dtk_feat_pattern::get_nb_input_ids ( int * )

Returns the number of feature's IDs to pattern.

Parameters

[in]	pattern	Feature
	[in/out]
[out]	int

Returns: NOTOK if error, ISOK if ok

Remarks

◆ get_nb_instances()

int Dtk_feat_pattern::get_nb_instances ( int * )

Returns the number of whole instances generated by the pattern feature .

Parameters

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

Returns: NOTOK if error, ISOK if ok

Remarks

◆ get_nb_objects_to_pattern()

int Dtk_feat_pattern::get_nb_objects_to_pattern ( int * )

Returns the number of objects to pattern.

Parameters

[in]	pattern	Feature
	[in/out]
[out]	int

Returns: NOTOK if error, ISOK if ok

Remarks

◆ get_object_type()

int Dtk_feat_pattern::get_object_type ( DTK_OBJECT_TYPE * )

Returns object type

Parameters

[in]	Pattern	Feature
	[in/out]
[out]	DTK_OBJECT_TYPE

Returns: NOTOK if error, ISOK if ok

Remarks

◆ get_objects_to_pattern()

int Dtk_feat_pattern::get_objects_to_pattern ( Dtk_tab< Dtk_feat_geometry * > & )

Returns the set of objects geometry to pattern.

Parameters

[in]	pattern	Feature
	[in/out]
[out]	Dtk_feat_geometry	** (the geometry of the objects to pattern)

Returns: NOTOK if error, ISOK if ok

Remarks

◆ get_rect_pattern()

int Dtk_feat_pattern::get_rect_pattern ( Dtk_feat_rect_pattern ** )

Returns the rectangular entity of the pattern feature.

Parameters

[in]	Pattern	Feature
	[in/out]
[out]	Dtk_feat_rect_pattern*

Returns: NOTOK if error, ISOK if ok

Remarks

◆ get_row1()

int Dtk_feat_pattern::get_row1 ( int * )

Returns the order of the base feature in the list of occurrences resulted of the pattern feature.

Parameters

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

Returns: NOTOK if error, ISOK if ok

Remarks: For Circular Pattern : Row1 is the order according to the angular Direction For Rectangular Pattern :; Row1 is the order according to the first Direction

◆ get_row2()

int Dtk_feat_pattern::get_row2 ( int * )

Returns the order of the base feature in the list of occurrences resulted of the pattern feature.

Parameters

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

Returns: NOTOK if error, ISOK if ok

Remarks: For Circular Pattern : Row2 is the order according to the Radial Direction, viz. the order of the base circle in the crown among the set of whole circles .For Rectangular Pattern : Row2 is the order according to the second Direction

◆ get_simple_rep()

int Dtk_feat_pattern::get_simple_rep ( Bool * )

Returns a boolean value indicating whether some inactive occurrences are set.

Parameters

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

Returns: NOTOK if error, ISOK if ok

Remarks: The option set the ability to users to delete some occurrences of the resulted pattern. Enabling this option, and double clicking on a simple occurrence fulfill the removal of selected occurrences.

◆ get_type()

int Dtk_feat_pattern::get_type ( DTK_PATTERN_TYPE * )

Returns pattern type

Parameters

[in]	Pattern	Feature
	[in/out]
[out]	DTK_PATTERN_TYPE

Returns: NOTOK if error, ISOK if ok

Remarks

Field Documentation

◆ active_instances

Bool* Dtk_feat_pattern::active_instances

◆ angle

double Dtk_feat_pattern::angle

◆ dtk_features

Dtk_tab<Dtk_FeaturePtr> Dtk_feat_pattern::dtk_features

◆ entity

union Dtk_feat_pattern::dtk_pattern_type Dtk_feat_pattern::entity

◆ gener_tool

bool Dtk_feat_pattern::gener_tool

◆ input_ids

Dtk_tab<long> Dtk_feat_pattern::input_ids

◆ keep_spec

Bool Dtk_feat_pattern::keep_spec

◆ nb_instances

int Dtk_feat_pattern::nb_instances

◆ object_type

DTK_OBJECT_TYPE Dtk_feat_pattern::object_type

◆ objects_placement

Dtk_tab<Dtk_transfo> Dtk_feat_pattern::objects_placement

◆ objects_to_pattern

Dtk_tab<Dtk_feat_geometry *> Dtk_feat_pattern::objects_to_pattern

◆ row1

int Dtk_feat_pattern::row1

◆ row2

int Dtk_feat_pattern::row2

◆ simple_rep

Bool Dtk_feat_pattern::simple_rep

◆ type

DTK_PATTERN_TYPE Dtk_feat_pattern::type

Data Structures

Public Member Functions

Data Fields

Constructor & Destructor Documentation

◆ Dtk_feat_pattern()

◆ ~Dtk_feat_pattern()

Member Function Documentation

◆ get_active_instances()

◆ get_angle()

◆ get_circ_pattern()

◆ get_features()

◆ get_gener_tool()

◆ get_input_ids()

◆ get_keep_spec()

◆ get_nb_features()

◆ get_nb_input_ids()

◆ get_nb_instances()

◆ get_nb_objects_to_pattern()

◆ get_object_type()

◆ get_objects_to_pattern()

◆ get_rect_pattern()

◆ get_row1()

◆ get_row2()

◆ get_simple_rep()

◆ get_type()

Field Documentation

◆ active_instances

◆ angle

◆ dtk_features

◆ entity

◆ gener_tool

◆ input_ids

◆ keep_spec

◆ nb_instances

◆ object_type

◆ objects_placement

◆ objects_to_pattern

◆ row1

◆ row2

◆ simple_rep

◆ type