Public View Protected View Private View

All Frameworks Class Hierarchy This Framework Indexes Previous Next

DraftingUseItf Interface CATIDftMotifPattern

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

interface CATIDftMotifPattern

Manage a Motif pattern.

Method Index

o GetAngle(double*): Get the angle of the used motif based on axis x (degre).
o GetMotif(wchar_t**): Get the Motif of a defined element.
o GetOffset(double*,double*): Get the offset of the used motif.
o GetPixelImage(CATPixelImage*): Get the image of the used motif.
o GetScale(double*): Get the scale of the used motif.
o SetAngle(double): Set the angle of the used motif.
o SetMotif(wchar_t*): Set the motif of the element.
o SetOffset(double,double): Set the offset of the used motif.
o SetPixelImage(CATPixelImage*): Set the image of the used motif.
o SetScale(double): Set the scale of the used motif.

Methods

o GetAngle

public virtual GetAngle( oAngle)

Get the angle of the used motif based on axis x (degre).

Parameters:

oAngle:: angle (degre) based on axis x

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 GetMotif

public virtual GetMotif( oMotif)

Get the Motif of a defined element.

Parameters:

oMotif:: bitmap image filename

Returns:

o GetOffset

public virtual GetOffset(		`oOffsetH`,
		`oOffsetV`)

Get the offset of the used motif.

Parameters:

oOffsetH:: horizontal offset of the motif
oOffsetV:: Vertical offset of the motif

Returns:

o GetPixelImage

public virtual GetPixelImage( oPixelImage)

Get the image of the used motif.

Parameters:

oPixelImage:: pixelImage

Returns:

o GetScale

public virtual GetScale( oScale)

Get the scale of the used motif.

Parameters:

oScale:: scale of the motif

Returns:

o SetAngle

public virtual SetAngle( const iAngle)

Set the angle of the used motif.

Parameters:

iAngle:: angle (degre) based on axis x

Returns:

o SetMotif

public virtual SetMotif( const iMotif)

Set the motif of the element.

Parameters:

iMotif:: bitmap image filename

Returns:

o SetOffset

public virtual SetOffset(	const	`iOffsetH`,
	const	`iOffsetV`)

Set the offset of the used motif.

Parameters:

iOffsetH:: horizontal offset of the motif
iOffsetV:: Vertical offset of the motif

Returns:

o SetPixelImage

public virtual SetPixelImage( const iPixelImage)

Set the image of the used motif.

Parameters:

iPixelImage:: pixelImage

Returns:

o SetScale

public virtual SetScale( const iScale)

Set the scale of the used motif.

Parameters:

iScale:: scale of the motif

Returns:

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