All Frameworks Class Hierarchy This Framework Previous Next Indexes
DraftingInterfaces Interface CATIDftMotifPattern
System.IUnknown
|
+---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 HRESULT GetAngle( | double* | oAngle) = 0 |
-
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 HRESULT GetMotif( | wchar_t** | oMotif)= 0 |
-
Get the Motif of a defined element.
- Parameters:
-
- oMotif:
- bitmap image filename
- 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 GetOffset
public virtual HRESULT GetOffset( | double* | oOffsetH, |
| double* | oOffsetV) = 0 |
-
Get the offset of the used motif.
- Parameters:
-
- oOffsetH:
- horizontal offset of the motif
- oOffsetV:
- Vertical offset of the motif
- 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 GetPixelImage
-
Get the image of the used motif.
- Parameters:
-
- oPixelImage:
- pixelImage
- 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 GetScale
public virtual HRESULT GetScale( | double* | oScale) = 0 |
-
Get the scale of the used motif.
- Parameters:
-
- oScale:
- scale of the motif
- 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 SetAngle
public virtual HRESULT SetAngle( | const double | iAngle) = 0 |
-
Set the angle of the used motif.
- Parameters:
-
- iAngle:
- 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 SetMotif
public virtual HRESULT SetMotif( | const wchar_t* | iMotif) = 0 |
-
Set the motif of the element.
- Parameters:
-
- iMotif:
- bitmap image filename
- 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 SetOffset
public virtual HRESULT SetOffset( | const double | iOffsetH, |
| const double | iOffsetV) = 0 |
-
Set the offset of the used motif.
- Parameters:
-
- iOffsetH:
- horizontal offset of the motif
- iOffsetV:
- Vertical offset of the motif
- 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 SetPixelImage
-
Set the image of the used motif.
- Parameters:
-
- iPixelImage:
- pixelImage
- 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 SetScale
public virtual HRESULT SetScale( | const double | iScale) = 0 |
-
Set the scale of the used motif.
- Parameters:
-
- iScale:
- scale of the motif
- 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.
This object is included in the file: CATIDftMotifPattern.h
If needed, your Imakefile.mk should include the module: CATDraftingInterfaces