All Frameworks  Class Hierarchy  This Framework  Previous  Next  Indexes

DraftingInterfaces Interface CATIDftHatchingPattern

System.IUnknown
  |
  +---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 HRESULT GetAngle( const int iHatching,
double* oAngle) = 0
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 HRESULT GetColor( const int iHatching,
int* oColor) = 0
Get the color number of a defined hatching element.
Parameters:
iHatching
(from 0 to oHatchingNb-1)
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 GetNbHatching
public virtual HRESULT GetNbHatching(int* oHatchingNb) = 0
Get the number of hatching elements.
Parameters:
oHatchingNb
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( const int iHatching,
double* oOffset) const = 0
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:
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( const int iHatching,
double* oPitch) = 0
Get the distance between 2 consecutive lines of a defined hatching element.
Parameters:
iHatching
(from 0 to oHatchingNb-1)
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 GetTexture
public virtual HRESULT GetTexture( const int iHatching,
int* oTexture) = 0
Get the texture number of a defined hatching element.
Parameters:
iHatching
(from 0 to oHatchingNb-1)
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 GetThikness
public virtual HRESULT GetThikness( const int iHatching,
int* oThikness) = 0
Get the thickness number of a defined hatching element.
Parameters:
iHatching
(from 0 to oHatchingNb-1)
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 hatching lines based on axis x (degre).
Parameters:
iAngle
Angle of the hatching
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 hatching 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 SetHatching
public virtual HRESULT SetHatching(CATIDftHatchingPattern* iHatching) = 0
Set a new Hatching element to the current one.
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 SetOffset
public virtual HRESULT SetOffset( const double iOffset) = 0
Set the offset between the sheet origin and the first hatching line.
Parameters:
oOffset
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 hatching 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 SetTexture
public virtual HRESULT SetTexture( const int iTexture) = 0
Set the texture number of the lines of the hatching 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 SetThikness
public virtual HRESULT SetThikness( const int iThikness) = 0
Set the thickness of the lines of the hatching 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.

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

Copyright © 2003, Dassault Systèmes. All rights reserved.