Dtk_feat_circ_pattern Class Reference

Public Member Functions
	Dtk_feat_circ_pattern ()
int	get_axial_reference (Dtk_feat_pattern_dir **)
	Returns the definition of the specified circular pattern feature (parameters + direction). More...
int	get_circle_spacing (double *)
	Returns the distance between two consecutive circles of the crown created. More...
int	get_crown_thickness (double *)
	Returns the maximum distance allowed between the first and the last circle of a crown (thickness of the whole crown). More...
int	get_nb_circles (int *)
	Returns the number of crown created from the original circular pattern (including the base circ pattern). More...
int	get_radial_alignment (Bool *)
	Returns the radial alignment defining the orientation of the created occurrences. More...
	~Dtk_feat_circ_pattern ()

Data Fields
Dtk_feat_pattern_dir *	axial_reference
double	circle_spacing
double	crown_thickness
int	nb_circles
Dtk_Double64	offset
Bool	radial_alignment

Constructor & Destructor Documentation

Dtk_feat_circ_pattern()

Dtk_feat_circ_pattern::Dtk_feat_circ_pattern

(

)

~Dtk_feat_circ_pattern()

Dtk_feat_circ_pattern::~Dtk_feat_circ_pattern

(

)

Member Function Documentation

get_axial_reference()

int Dtk_feat_circ_pattern::get_axial_reference

(

Dtk_feat_pattern_dir **

)

Returns the definition of the specified circular pattern feature (parameters + direction).

Parameters

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

Returns

NOTOK if error, ISOK if ok

Remarks

get_circle_spacing()

int Dtk_feat_circ_pattern::get_circle_spacing

(

double *

)

Returns the distance between two consecutive circles of the crown created.

Parameters

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

Returns

NOTOK if error, ISOK if ok

Remarks

get_crown_thickness()

int Dtk_feat_circ_pattern::get_crown_thickness

(

double *

)

Returns the maximum distance allowed between the first and the last circle of a crown (thickness of the whole crown).

Parameters

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

Returns

NOTOK if error, ISOK if ok

Remarks

Crown Thickness = ( Number Circles - 1 ) * ( Circle Spacing )

get_nb_circles()

int Dtk_feat_circ_pattern::get_nb_circles

(

int *

)

Returns the number of crown created from the original circular pattern (including the base circ pattern).

Parameters

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

Returns

NOTOK if error, ISOK if ok

Remarks

get_radial_alignment()

int Dtk_feat_circ_pattern::get_radial_alignment

(

Bool *

)

Returns the radial alignment defining the orientation of the created occurrences.

Parameters

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

Returns

NOTOK if error, ISOK if ok

Remarks

Field Documentation

axial_reference

Dtk_feat_pattern_dir* Dtk_feat_circ_pattern::axial_reference

circle_spacing

double Dtk_feat_circ_pattern::circle_spacing

crown_thickness

double Dtk_feat_circ_pattern::crown_thickness

nb_circles

int Dtk_feat_circ_pattern::nb_circles

offset

Dtk_Double64 Dtk_feat_circ_pattern::offset

radial_alignment

Bool Dtk_feat_circ_pattern::radial_alignment