Public View Protected View Private View

All Frameworks Class Hierarchy This Framework Indexes Previous Next

DraftingUseItf Interface CATIDftHatchingPattern

Usage: an implementation of this interface is supplied and you must use it as is. You should not reimplement it.

interface CATIDftHatchingPattern

Manage a hatching pattern.

Method Index

o GetAngle(int,double*): Get the angle of lines based on axis x (degre), for a defined hatching element.
o GetColor(int,int*): Get the color number of a defined hatching element.
o GetNbHatching(int*): Get the number of hatching elements.
o GetOffset(int,double*): Get the offset between the sheet origin and the first hatching line of the defined hatching element.
o GetPitch(int,double*): Get the distance between 2 consecutive lines of a defined hatching element.
o GetTexture(int,int*): Get the texture number of a defined hatching element.
o GetThikness(int,int*): Get the thickness number of a defined hatching element.
o SetAngle(double): Set the angle of hatching lines based on axis x (degre).
o SetColor(int): Set the color number of the lines of the hatching element.
o SetHatching(CATIDftHatchingPattern*): Set a new Hatching element to the current one.
o SetOffset(double): Set the offset between the sheet origin and the first hatching line.
o SetPitch(double): Set the distance between 2 consecutive lines of the hatching element.
o SetTexture(int): Set the texture number of the lines of the hatching element.
o SetThikness(int): Set the thickness of the lines of the hatching element.

Methods

o GetAngle

public virtual GetAngle(	const	`iHatching`,
		`oAngle`)

Get the angle of lines based on axis x (degre), for a defined hatching element.

Parameters:

iHatching: (from 0 to oHatchingNb-1)
oAngle: Angle of the lines.

Returns:

S_OK : Method correctly executed.
No restriction.
S_READONLY : Method correctly executed.
Returned value cannot be modified, it's read-only.
Can be usefull when the property is fixed by a standard, etc.
S_UNDEFINED : Method correctly executed.
Returned value is undefined.
Case of an object having several subparts supporting the same property with a different value.
E_FAIL : Method execution failed.
Reasons of the failure are not given.
E_NOTIMPL : No implementation available for this method.

o GetColor

public virtual GetColor(	const	`iHatching`,
		`oColor`)

Get the color number of a defined hatching element.

Parameters:

iHatching: (from 0 to oHatchingNb-1)

Returns:

o GetNbHatching

public virtual GetNbHatching( oHatchingNb)

Get the number of hatching elements.

Parameters:

oHatchingNb

Returns:

o GetOffset

public virtual GetOffset(	const	`iHatching`,
		`oOffset`)

Get the offset between the sheet origin and the first hatching line of the defined hatching element.

Parameters:

iHatching: (from 0 to oHatchingNb-1)
oOffset

Returns:

o GetPitch

public virtual GetPitch(	const	`iHatching`,
		`oPitch`)

Get the distance between 2 consecutive lines of a defined hatching element.

Parameters:

iHatching: (from 0 to oHatchingNb-1)

Returns:

o GetTexture

public virtual GetTexture(	const	`iHatching`,
		`oTexture`)

Get the texture number of a defined hatching element.

Parameters:

iHatching: (from 0 to oHatchingNb-1)

Returns:

o GetThikness

public virtual GetThikness(	const	`iHatching`,
		`oThikness`)

Get the thickness number of a defined hatching element.

Parameters:

iHatching: (from 0 to oHatchingNb-1)

Returns:

o SetAngle

public virtual SetAngle( const iAngle)

Set the angle of hatching lines based on axis x (degre).

Parameters:

iAngle: Angle of the hatching

Returns:

o SetColor

public virtual SetColor( const iColor)

Set the color number of the lines of the hatching element.

Parameters:

Returns:

o SetHatching

public virtual SetHatching( iHatching)

Set a new Hatching element to the current one.

Parameters:

Returns:

o SetOffset

public virtual SetOffset( const iOffset)

Set the offset between the sheet origin and the first hatching line.

Parameters:

oOffset

Returns:

o SetPitch

public virtual SetPitch( const iPitch)

Set the distance between 2 consecutive lines of the hatching element.

Parameters:

iPitch: The pitch value

Returns:

o SetTexture

public virtual SetTexture( const iTexture)

Set the texture number of the lines of the hatching element.

Parameters:

Returns:

o SetThikness

public virtual SetThikness( const iThikness)

Set the thickness of the lines of the hatching element.

Parameters:

Returns:

This object is included in the file: CATIDftHatchingPattern.h
If needed, your Imakefile.mk should include the module: CATDraftingUseItf