All Frameworks Class Hierarchy This Framework Previous Next Indexes
DraftingInterfaces Interface CATIDftDottingPattern
System.IUnknown
|
+---CATIDftDottingPattern
Usage: an implementation of this interface is supplied and you must use it as is. You should not reimplement it.
interface CATIDftDottingPattern
Manage a Dotting pattern.
Method Index
- o
GetBrightness(int*)
- Get the brightness of the dots of a defined Dotting element.
- o
GetColor(int*)
- Get the color number of a defined Dotting element.
- o
GetPitch(double*)
- Get the distance between 2 consecutive lines of a defined Dotting element.
- o
GetZigZag(int*)
- Get the zigzag of the dots of a defined Dotting element.
- o
SetBrightness(int)
- Set the brightness of the dots of the Dotting element.
- o
SetColor(int)
- Set the color number of the lines of the Dotting element.
- o
SetPitch(double)
- Set the distance between 2 consecutive lines of the Dotting element.
- o
SetZigZag(int)
- Set the zigzag of the dots of the Dotting element.
Methods
o GetBrightness
public virtual HRESULT GetBrightness( | int* | oBright) = 0 |
-
Get the brightness of the dots of a defined Dotting element.
- Parameters:
-
- oBright
- The brightness of the dotting pattern.
- 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 HRESULT GetColor( | int* | oColor) = 0 |
-
Get the color number of a defined Dotting element.
- Parameters:
-
-
- 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 GetPitch
public virtual HRESULT GetPitch( | double* | oPitch) = 0 |
-
Get the distance between 2 consecutive lines of a defined Dotting element.
- Parameters:
-
- oPitch
- The Pitch value.
- 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 GetZigZag
public virtual HRESULT GetZigZag( | int* | oZigZag) = 0 |
-
Get the zigzag of the dots of a defined Dotting element.
- Parameters:
-
-
- 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 SetBrightness
public virtual HRESULT SetBrightness( | const int | iBright) = 0 |
-
Set the brightness of the dots of the Dotting element.
- Parameters:
-
- iBright<1,6>
- Brightness
Legal values:
Between 1 and 6
- 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 SetColor
public virtual HRESULT SetColor( | const int | iColor) = 0 |
-
Set the color number of the lines of the Dotting element.
- Parameters:
-
- iColor
- Color ot the dotting pattern.
- 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 SetPitch
public virtual HRESULT SetPitch( | const double | iPitch) = 0 |
-
Set the distance between 2 consecutive lines of the Dotting element.
- Parameters:
-
- iPitch
- The Pitch value.
- 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 SetZigZag
public virtual HRESULT SetZigZag( | const int | iZigZag) = 0 |
-
Set the zigzag of the dots of the Dotting element.
- Parameters:
-
- iZigZag
-
Legal values:
<= 0, dots are aligned
= 1, dots are shifted all the 2
- 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: CATIDftDottingPattern.h
If needed, your Imakefile.mk should include the module: CATDraftingInterfaces