CATSketcherUseItf Interface CATISktUseSketchPositioning
Usage: an implementation of this interface is supplied and you must use it as is. You should not reimplement it.
interface CATISktUseSketchPositioning
Interface to manage the positioning of a sketch.
Role: This interface is used to manage the attributes of a sketch
from which the position will be computed.
Method Index
- o
EvalPosition(HRESULT&,HRESULT&,HRESULT&,int,int)
- Compute, evaluate and analyze the new position of the sketch.
- o
GetDirectionCoordinates(CATLISTV(CATIMmiMechanicalFeature_var)&)
- Retrieves the direction coordinates for orientation.
- o
GetHDirectionSense(int&)
- Retrieves the Horizontal direction.
- o
GetNormalSense(int&)
- Retrieves the Normal direction.
- o
GetOrientationDirection(CATSktPosDirection&)
- Retrieves the direction of the sketch axis which is oriented.
- o
GetOrientationMode(CATSktPosOrientationMode&)
- Retrieves the orientation definition mode.
- o
GetOrientationReferences(CATLISTV(CATIMmiMechanicalFeature_var)&)
- Retrieves the orientation reference elements.
- o
GetOriginMode(CATSktPosOriginMode&)
- Retrieves the origin definition mode.
- o
GetOriginReferences(CATLISTV(CATIMmiMechanicalFeature_var)&)
- Retrieves the origin reference elements.
- o
GetSupportMode(CATSktPosSupportMode&)
- Retrieves the support definition mode.
- o
GetSupportReferences(CATLISTV(CATIMmiMechanicalFeature_var)&)
- Retrieves the support reference elements.
- o
GetVDirectionSense(int&)
- Retrieves the Vertical direction.
- o
PositionAsReference()
-
Role: Puts the sketch ARWL (As Result With Link) at the same position as the original sketch,
and set the type of the sketch on CATSktSupPositionedAsRef
- o
ReverseHDirection(void)
- Reverses the Horizontal direction.
- o
ReverseVDirection(void)
- Reverses the Vertical direction.
- o
SetOrientationDirection(CATSktPosDirection)
- Sets the oriented direction of the sketch axis.
- o
SetOrientationMode(CATSktPosOrientationMode)
- Sets the orientation definition mode.
- o
SetOrientationReferences(CATLISTV(CATBaseUnknown_var)&)
- Sets the orientation reference elements.
- o
SetOriginMode(CATSktPosOriginMode)
- Sets the origin definition mode.
- o
SetOriginReferences(CATLISTV(CATBaseUnknown_var)&)
- Sets the origin reference elements and definition mode.
- o
SetSupportMode(CATSktPosSupportMode)
- Sets the support definition mode.
- o
SetSupportReferences(CATLISTV(CATBaseUnknown_var)&)
- Sets the support reference elements.
- o
SwapHVDirections(void)
- Swaps the Horizontal and Vertical directions.
Methods
o EvalPosition
| public virtual EvalPosition( | | oSupportStatus, |
| | oOriginStatus, |
| | oOrientationStatus, |
| const | iEvaluationMode | =1, |
| const | iMovingMode | =1) |
-
Compute, evaluate and analyze the new position of the sketch.
Role: This method lets you know if the sketch is correctly positioned.
- Parameters:
-
- oSupportStatus
- [out] Evaluation status of the sketch support positioning
- oOriginStatus
- [out] Evaluation status of the sketch origin positioning
- oOrientationStatus
- [out] Evaluation status of the sketch orientation positioning
- iEvaluationMode
- [in] Evaluation mode
Legal values: The evaluation mode value can be 1 for creation state or 2 for edition state.
- iMovingMode
- [in] Moving mode
Legal values: The moving mode value can be 1 to move the absolute axis and the sketch geometry or
0 to move the absolute axis only.
- Returns:
- HRESULT
o GetDirectionCoordinates
| public virtual GetDirectionCoordinates( | | oXYZ_output) |
-
Retrieves the direction coordinates for orientation.
- Parameters:
-
- oXYZ
- [out] A list of 3 literal parameters for each coordinate.
- Returns:
- HRESULT
o GetHDirectionSense
| public virtual GetHDirectionSense( | | oDirection) |
-
Retrieves the Horizontal direction.
- Parameters:
-
- oDirection
- [out] Direction coefficient.
- +1
- Same direction.
- -1
- Reverse direction.
- Returns:
- HRESULT
o GetNormalSense
| public virtual GetNormalSense( | | oDirection) |
-
Retrieves the Normal direction.
- Parameters:
-
- oDirection
- [out] Direction coefficient.
- +1
- Same direction.
- -1
- Reverse direction.
- Returns:
- HRESULT
o GetOrientationDirection
| public virtual GetOrientationDirection( | | oDirection) |
-
Retrieves the direction of the sketch axis which is oriented.
Role: The orientation direction lets you specify whether
the orientation references will be applied on axis H or V.
Direction definitions are listed in the
definition.
- Parameters:
-
- oDirection
- [out] Oriented direction.
Legal values: The oriented direction value can be CATSktDirHorizontal for the horizontal axis
or CATSktDirVertical for the vertical axis.
- Returns:
- HRESULT
o GetOrientationMode
| public virtual GetOrientationMode( | | oMode) |
-
Retrieves the orientation definition mode.
Role: The orientation definition mode lets you define the absolute axis orientation.
Orientation definition modes are listed in the
definition.
- Parameters:
-
- oMode
- [out] Orientation definition mode.
e.g.: CATSktOrtThroughAPoint
- Returns:
- HRESULT
o GetOrientationReferences
| public virtual GetOrientationReferences( | | oReferences_output) |
-
Retrieves the orientation reference elements.
- Parameters:
-
- oReferences
- [out] List of orientation reference elements.
- Returns:
- HRESULT
o GetOriginMode
| public virtual GetOriginMode( | | oMode) |
-
Retrieves the origin definition mode.
Role: The origin definition mode lets you define the sketch origin.
Origin definition modes are listed in the
definition.
- Parameters:
-
- oMode
- [out] Origin definition mode.
e.g.: CATSktOriPartOrigin
- Returns:
- HRESULT
o GetOriginReferences
| public virtual GetOriginReferences( | | oReferences_output) |
-
Retrieves the origin reference elements.
- Parameters:
-
- oReferences
- [out] List of origin reference elements.
- Returns:
- HRESULT
o GetSupportMode
| public virtual GetSupportMode( | | oMode) |
-
Retrieves the support definition mode.
Role: The support definition mode lets you define the sketch support references.
Support definition modes are listed in the
definition.
- Parameters:
-
- oMode
- [out] Support definition mode.
e.g.: CATSktSupOnePlane
- Returns:
- HRESULT
o GetSupportReferences
| public virtual GetSupportReferences( | | oReferences_output) |
-
Retrieves the support reference elements.
- Parameters:
-
- oReferences
- [out] List of support reference elements.
- Returns:
- HRESULT
o GetVDirectionSense
| public virtual GetVDirectionSense( | | oDirection) |
-
Retrieves the Vertical direction.
- Parameters:
-
- oDirection
- [out] Direction coefficient.
- +1
- Same direction.
- -1
- Reverse direction.
- Returns:
- HRESULT
o PositionAsReference
| public virtual PositionAsReference( | ) |
-
Role: Puts the sketch ARWL (As Result With Link) at the same position as the original sketch,
and set the type of the sketch on CATSktSupPositionedAsRef
- Returns:
- HRESULT - S_OK, if the sketch has been successfully positioned as its reference.
- E_FAIL, otherwise.
o ReverseHDirection
| public virtual ReverseHDirection( | | ) |
-
Reverses the Horizontal direction.
- Returns:
- HRESULT
o ReverseVDirection
| public virtual ReverseVDirection( | | ) |
-
Reverses the Vertical direction.
- Returns:
- HRESULT
o SetOrientationDirection
| public virtual SetOrientationDirection( | const | iDirection) |
-
Sets the oriented direction of the sketch axis.
Role: The orientation direction allows lets you specify whether
the orientation references will be applied on axis H or V.
Direction definitions are listed in the
definition.
- Parameters:
-
- iDirection
- [in] Oriented direction.
Legal values: The oriented direction value can be CATSktDirHorizontal for the horizontal axis
or CATSktDirVertical for the vertical axis.
- Returns:
- HRESULT
o SetOrientationMode
| public virtual SetOrientationMode( | const | iMode) |
-
Sets the orientation definition mode.
Role: The orientation definition mode lets you define the absolute axis orientation.
Orientation definition modes are listed in the
definition.
- Parameters:
-
- iMode
- [in] Origin definition mode.
e.g.: CATSktOrtThroughAPoint
- Returns:
- HRESULT
o SetOrientationReferences
| public virtual SetOrientationReferences( | const | iReferences) |
-
Sets the orientation reference elements.
- Parameters:
-
- iReferences
- [in] List of orientation reference elements.
- Returns:
- HRESULT
o SetOriginMode
| public virtual SetOriginMode( | const | iMode) |
-
Sets the origin definition mode.
Role: The origin definition mode lets you define the sketch origin.
Origin definition modes are listed in the
definition.
- Parameters:
-
- iMode
- [in] Origin definition mode.
e.g.: CATSktOriPartOrigin
- Returns:
- HRESULT
o SetOriginReferences
| public virtual SetOriginReferences( | const | iReferences) |
-
Sets the origin reference elements and definition mode.
- Parameters:
-
- iReferences
- [in] List of origin reference elements.
- Returns:
- HRESULT
o SetSupportMode
| public virtual SetSupportMode( | const | iMode) |
-
Sets the support definition mode.
Role: The support definition mode lets you define the sketch support references.
Support definition modes are listed in the
definition.
- Parameters:
-
- iMode
- [in] Support definition mode.
e.g.: CATSktSupOnePlane
- Returns:
- HRESULT
o SetSupportReferences
| public virtual SetSupportReferences( | const | iReferences) |
-
Sets the support reference elements.
- Parameters:
-
- iReferences
- [in] List of support reference elements.
- Returns:
- HRESULT
o SwapHVDirections
| public virtual SwapHVDirections( | | ) |
-
Swaps the Horizontal and Vertical directions.
- Returns:
- HRESULT
This object is included in the file: CATISktUseSketchPositioning.h
If needed, your Imakefile.mk should include the module: CATSketcherUseItf
Copyright © 1999-2014, Dassault Systèmes. All rights reserved.