All Frameworks  Class Hierarchy  This Framework  Previous  Next  Indexes

GSMInterfaces Interface CATIGSMTrim

System.IUnknown
  |
  +---System.IDispatch
    |
    +---System.CATBaseUnknown
      |
      +---CATIGSMTrim
 

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


interface CATIGSMTrim

Interface to trim feature.
Role: Allows you to access data of the Trim feature created by using two elements (two curves or two surfaces) and two orientations

See also:
CATIGSMFactory.CreateTrim


Method Index


o AddElem(CATISpecObject_var&)
Appends an element to trim.
o AddElementToKeep(CATISpecObject_var)
Adds an element to specifications.
o AddElementToRemove(CATISpecObject_var)
Adds an element to specifications.
o GetAutomaticExtrapolationMode(CATBoolean&)
Queries whether automatic extrapolation mode is activated or not.
o GetConnexMode(CATBoolean&)
Gets the connected mode.
o GetElem(CATISpecObject_var&,int)
Gets the trimmed feature at a given index.
o GetElems(CATLISTV(CATISpecObject_var)&)
Gets the list of trimmed features, removing duplicated.
o GetFirstElem(CATISpecObject_var&)
o GetFirstOrientation(CATGSMOrientation&)
o GetIntersection(CATISpecObject_var&)
Gets the intersection.
o GetIntersectionComputation(CATBoolean&)
Queries whether intersection is computed or not.
o GetKeptElem(CATISpecObject_var&,int)
Gets the kept feature at a given index.
o GetManifoldMode(CATBoolean&)
Gets the Manifold mode.
o GetMode(int&)
Gets Trim mode.
o GetNbElem(int&)
Gets the number of elements: couple(element, index of portion to keep on element).
o GetNbElementsToKeep(int&)
Gets the number of elements to keep.
o GetNbElementsToRemove(int&)
Gets the number of elements to remove.
o GetNextOrientation(CATGSMOrientation&,int)
Gets Orientation used to compute the feature, referring to the next trimmed element.
o GetNumberOfIntersections(CATISpecObject_var,int&)
Gets the number of intersections with the other elements, the index of the element, in Pieces mode.
o GetPortionToKeep(int&,int)
Gets a portion to keep number, giving the index of the element.
o GetPreviousOrientation(CATGSMOrientation&,int)
Gets Orientation used to compute the feature, referring to the previous trimmed element.
o GetRemovedElem(CATISpecObject_var&,int)
Gets the removed feature at a given index.
o GetSecondElem(CATISpecObject_var&)
o GetSecondOrientation(CATGSMOrientation&)
o GetSimplify(CATBoolean&)
Queries whether resulting topology is simplified or not.
o GetSupportElem(CATISpecObject_var&)
Gets the support of the curves to trim (optional).
o InsertElem(CATISpecObject_var,int)
Inserts an element.
o InvertFirstOrientation()
o InvertNextOrientation(int)
Inverts the orientation used to compute the trim refering the next trimmed element.
o InvertPreviousOrientation(int)
Inverts the orientation used to compute the trim refering the previous trimmed element.
o InvertSecondOrientation()
o MigrateFromBinary()
Migrate binary feature to Standard mode.
o RemoveElem(int)
Removes a feature at a given index.
o RemoveElementToKeep(int)
Removes an element from specifications.
o RemoveElementToRemove(int)
Removes an element from specifications.
o SetAutomaticExtrapolationMode(CATBoolean)
Sets or unsets the automatic extrapolation mode.
o SetConnexMode(CATBoolean)
Sets the connected mode.
o SetElem(CATISpecObject_var,int)
Modifies the trimmed feature at a given index.
o SetFirstElem(CATISpecObject_var)
o SetFirstOrientation(CATGSMOrientation)
o SetIntersectionComputation(CATBoolean)
Sets or unsets the computation of intersection.
o SetManifoldMode(CATBoolean)
Sets the Manifold mode.
o SetMode(int)
Sets Trim mode.
o SetNextOrientation(CATGSMOrientation,int)
Sets the orientation used to compute the feature, referring to the next trimmed element.
o SetNumberOfIntersections(CATISpecObject_var,int)
Sets the number of intersections with the other elements, in Pieces mode.
o SetPortionToKeep(int,int)
Sets a portion to keep number in Pieces mode.
o SetPreviousOrientation(CATGSMOrientation,int)
Sets the orientation used to compute the feature, referring to the previous trimmed element.
o SetSecondElem(CATISpecObject_var)
o SetSecondOrientation(CATGSMOrientation)
o SetSimplify(CATBoolean)
Sets or unsets the simplification of the resulting topology.
o SetSupportElem(CATISpecObject_var)
Sets the support of the curves to trim (optional).

Methods


o AddElem
public virtual HRESULT AddElem( const CATISpecObject_var& iElem) = 0
Appends an element to trim.
Parameters:
iElem
feature to trim
o AddElementToKeep
public virtual HRESULT AddElementToKeep( const CATISpecObject_var iElement) = 0
Adds an element to specifications. This element will be kept.
Parameters:
iElement
Element to keep.
o AddElementToRemove
public virtual HRESULT AddElementToRemove( const CATISpecObject_var iElement) = 0
Adds an element to specifications. This element will be removed.
Parameters:
iElement
Element to remove.
o GetAutomaticExtrapolationMode
public virtual HRESULT GetAutomaticExtrapolationMode(CATBoolean& oMode) = 0
Queries whether automatic extrapolation mode is activated or not.
Parameters:
oMode
Extrapolation mode on (TRUE) or off (FALSE)
o GetConnexMode
public virtual HRESULT GetConnexMode(CATBoolean& oConnex) = 0
Gets the connected mode.
Parameters:
oConnex
CATFalse = non connected elements, CATTrue = only connected elements
See also:
CATBoolean
o GetElem
public virtual HRESULT GetElem(CATISpecObject_var& oElem,
const int iRank) = 0
Gets the trimmed feature at a given index.
Parameters:
oElem
trimmed feature
iRank
Index of one of the trimmed features
o GetElems
public virtual HRESULT GetElems(CATLISTV(CATISpecObject_var)& oElems) = 0
Gets the list of trimmed features, removing duplicated.
Parameters:
oElems
The list of trimmed features
o GetFirstElem
public virtual HRESULT GetFirstElem(CATISpecObject_var& oElem) = 0
Deprecated:
V5R17 CATIGSMTrim#GetElem Gets the first feature to trim (a curve or surface).
Parameters:
oElem
first feature to trim
o GetFirstOrientation
public virtual HRESULT GetFirstOrientation(CATGSMOrientation& oOrientation) = 0
Deprecated:
V5R17 CATIGSMTrim#GetNextOrientation Gets the first orientation used to compute the trim. Orientation specifies kept parts of first feature.

When trimming surfaces :
- If CATGSMSameOrientation: Kept parts are specified by the "natural" normal to the second feature
- If CATGSMInvertOrientation: Kept parts are specified by the inverse of the "natural" normal to the second feature

When trimming curves (without support):
- If CATGSMSameOrientation: Kept parts are from beginning of the curve to the first intersection,
and ,if there is one, from the second to the third intersection and so on until the end of the curve...
- If CATGSMInvertOrientation: Kept parts are from the first intersection to the second (if there is one),
and, if there is one, from the third to the fourth and so on until the end of the curve...

When trimming curves on support:
- If CATGSMSameOrientation:
Kept parts of the first curve are specified by the result of the cross product : normal(support surface)^tangent(second curve)
- If CATGSMInvertOrientation:
Kept parts of the first curve are specified by the inverse of the result of the cross product : normal(support surface)^tangent(second curve)

Parameters:
oOrientation
first orientation used to compute the trim
o GetIntersection
public virtual HRESULT GetIntersection(CATISpecObject_var& oElem) = 0
Gets the intersection.
Parameters:
oElem
Intersection
o GetIntersectionComputation
public virtual HRESULT GetIntersectionComputation(CATBoolean& oMode) = 0
Queries whether intersection is computed or not.
Parameters:
oMode
Computation option on (TRUE) or off (FALSE)
o GetKeptElem
public virtual HRESULT GetKeptElem(CATISpecObject_var& oElem,
const int iRank) = 0
Gets the kept feature at a given index.
Parameters:
oElem
Kept feature
iRank
Index of one of the kept features
o GetManifoldMode
public virtual HRESULT GetManifoldMode(CATBoolean& oIsManifold) = 0
Gets the Manifold mode.
Parameters:
oIsManifold
CATFalse = the check is not performed (non manifold result is allowed), CATTrue = the check is performed.
See also:
CATBoolean
o GetMode
public virtual HRESULT GetMode(int& oMode) = 0
Gets Trim mode.
Parameters:
oMode
=1 Standard =2 Pieces
o GetNbElem
public virtual HRESULT GetNbElem(int& oNbElem) = 0
Gets the number of elements: couple(element, index of portion to keep on element).
Parameters:
oNbElem
Number of elements
o GetNbElementsToKeep
public virtual HRESULT GetNbElementsToKeep(int& oNbElementsToKeep) = 0
Gets the number of elements to keep.
Parameters:
oNbElementsToKeep
Number of elements to keep
o GetNbElementsToRemove
public virtual HRESULT GetNbElementsToRemove(int& oNbElementsToRemove) = 0
Gets the number of elements to remove.
Parameters:
oNbElementsToRemove
Number of elements to remove
o GetNextOrientation
public virtual HRESULT GetNextOrientation(CATGSMOrientation& oOrientation,
const int iRank=1) = 0
Gets Orientation used to compute the feature, referring to the next trimmed element.
Parameters:
oOrientation
Orientation
iRank
index of the trimmed feature
o GetNumberOfIntersections
public virtual HRESULT GetNumberOfIntersections( const CATISpecObject_var iElem,
int& oNbIntersections) =0
Gets the number of intersections with the other elements, the index of the element, in Pieces mode. If iNumberOfIntersections<0, No check of the number of intersections at Update
Parameters:
iElem
trimmed feature
oNbIntersections
Number of intersections
o GetPortionToKeep
public virtual HRESULT GetPortionToKeep(int& oPortionNumber,
const int iRank) = 0
Gets a portion to keep number, giving the index of the element.
Parameters:
oPortionNumber
Index of portion to keep on the element
iRank
Index of the trimmed element
o GetPreviousOrientation
public virtual HRESULT GetPreviousOrientation(CATGSMOrientation& oOrientation,
const int iRank=1) = 0
Gets Orientation used to compute the feature, referring to the previous trimmed element.
Parameters:
oOrientation
Orientation
iRank
index of the trimmed feature
o GetRemovedElem
public virtual HRESULT GetRemovedElem(CATISpecObject_var& oElem,
const int iRank) = 0
Gets the removed feature at a given index.
Parameters:
oElem
Removed feature
iRank
Index of one of the removed features
o GetSecondElem
public virtual HRESULT GetSecondElem(CATISpecObject_var& oElem) = 0
Deprecated:
V5R17 CATIGSMTrim#GetElem Gets the second feature to trim (a curve or surface).
Parameters:
oElem
second feature to cut
o GetSecondOrientation
public virtual HRESULT GetSecondOrientation(CATGSMOrientation& oOrientation) = 0
Deprecated:
V5R17 CATIGSMTrim#GetPreviousOrientation Gets the second orientation used to compute the trim. Orientation specifies kept parts of second feature.

When trimming surfaces :
- If CATGSMSameOrientation: Kept parts are specified by the "natural" normal to the first feature
- If CATGSMInvertOrientation: Kept parts are specified by the inverse of the "natural" normal to the first feature

When trimming curves (without support):
- If CATGSMSameOrientation: Kept parts are from beginning of the curve to the first intersection,
and ,if there is one, from the second to the third intersection and so on until the end of the curve...
- If CATGSMInvertOrientation: Kept parts are from the first intersection to the second (if there is one),
and, if there is one, from the third to the fourth and so on until the end of the curve...

When trimming curves on support:
- If CATGSMSameOrientation:
Kept parts of the second curve are specified by the result of the cross product : normal(support surface)^tangent(first curve)
- If CATGSMInvertOrientation:
Kept parts of the second curve are specified by the inverse of the result of the cross product : normal(support surface)^tangent(first curve)

Parameters:
oOrientation
second orientation used to compute the trim
o GetSimplify
public virtual HRESULT GetSimplify(CATBoolean& oMode) = 0
Queries whether resulting topology is simplified or not.
Parameters:
oMode
Simplification option on (TRUE) or off (FALSE)
o GetSupportElem
public virtual HRESULT GetSupportElem(CATISpecObject_var& oElem) = 0
Gets the support of the curves to trim (optional).
Parameters:
oElem
Support surface
o InsertElem
public virtual HRESULT InsertElem( const CATISpecObject_var iElem,
const int iPosition) = 0
Inserts an element.
Parameters:
iPosition
The position of the element in the list of elements.
iElem
the element.
o InvertFirstOrientation
public virtual HRESULT InvertFirstOrientation()= 0
Deprecated:
V5R17 CATIGSMTrim#InvertNextOrientation Inverts the first orientation used to compute the trim.
o InvertNextOrientation
public virtual HRESULT InvertNextOrientation( const int iRank=1) = 0
Inverts the orientation used to compute the trim refering the next trimmed element.
o InvertPreviousOrientation
public virtual HRESULT InvertPreviousOrientation( const int iRank=1) = 0
Inverts the orientation used to compute the trim refering the previous trimmed element.
o InvertSecondOrientation
public virtual HRESULT InvertSecondOrientation()= 0
Deprecated:
V5R17 CATIGSMTrim#InvertPreviousOrientation Inverts the second orientation used to compute the trim.
o MigrateFromBinary
public virtual HRESULT MigrateFromBinary()= 0
Migrate binary feature to Standard mode.
o RemoveElem
public virtual HRESULT RemoveElem( const int iRank) = 0
Removes a feature at a given index.
Parameters:
iRank
index of the feature
o RemoveElementToKeep
public virtual HRESULT RemoveElementToKeep( const int iRank) = 0
Removes an element from specifications.
Parameters:
iRank
Index of the kept element.
o RemoveElementToRemove
public virtual HRESULT RemoveElementToRemove( const int iRank) = 0
Removes an element from specifications.
Parameters:
iRank
Index of the removed element.
o SetAutomaticExtrapolationMode
public virtual HRESULT SetAutomaticExtrapolationMode(CATBoolean iMode) = 0
Sets or unsets the automatic extrapolation mode.
Parameters:
iMode
Extrapolation mode on (TRUE) or off (FALSE)
o SetConnexMode
public virtual HRESULT SetConnexMode(CATBoolean iConnex) = 0
Sets the connected mode.
Parameters:
iConnex
CATTrue = the check of connexity is enable, CATFalse = the check of connexity is disable.
See also:
CATBoolean
o SetElem
public virtual HRESULT SetElem( const CATISpecObject_var iElem,
const int iRank) = 0
Modifies the trimmed feature at a given index. Use AddElem method to specify a new trimmed element
Parameters:
iElem
trimmed feature
iRank
Index of one of the trimmed features
o SetFirstElem
public virtual HRESULT SetFirstElem( const CATISpecObject_var iElem) = 0
Deprecated:
V5R17 CATIGSMTrim#SetElem Sets the first feature to trim (a curve or surface).
Parameters:
iElem
first feature to trim
o SetFirstOrientation
public virtual HRESULT SetFirstOrientation(CATGSMOrientation iOrientation) = 0
Deprecated:
V5R17 CATIGSMTrim#SetNextOrientation(1) Sets the first orientation used to compute the trim. Orientation specifies kept parts of first feature.

When trimming surfaces :
- If CATGSMSameOrientation: Kept parts are specified by the "natural" normal to the second feature
- If CATGSMInvertOrientation: Kept parts are specified by the inverse of the "natural" normal to the second feature

When trimming curves (without support):
- If CATGSMSameOrientation: Kept parts are from beginning of the curve to the first intersection,
and ,if there is one, from the second to the third intersection and so on until the end of the curve...
- If CATGSMInvertOrientation: Kept parts are from the first intersection to the second (if there is one),
and, if there is one, from the third to the fourth and so on until the end of the curve...

When trimming curves on support:
- If CATGSMSameOrientation:
Kept parts of the first curve are specified by the result of the cross product : normal(support surface)^tangent(second curve)
- If CATGSMInvertOrientation:
Kept parts of the first curve are specified by the inverse of the result of the cross product : normal(support surface)^tangent(second curve)

Parameters:
iOrientation
first orientation used to compute the trim
o SetIntersectionComputation
public virtual HRESULT SetIntersectionComputation(CATBoolean iMode) = 0
Sets or unsets the computation of intersection.
Parameters:
iMode
Computation option on (TRUE) or off (FALSE)
o SetManifoldMode
public virtual HRESULT SetManifoldMode(CATBoolean iIsManifold) = 0
Sets the Manifold mode.
Parameters:
iIsManifold
CATFalse = the check is not performed (non manifold result is allowed), CATTrue = the check is performed.
See also:
CATBoolean
o SetMode
public virtual HRESULT SetMode( const int iMode) = 0
Sets Trim mode.
Parameters:
iMode
=1 Standard =2 Pieces
o SetNextOrientation
public virtual HRESULT SetNextOrientation(CATGSMOrientation iOrientation,
int iRank) = 0
Sets the orientation used to compute the feature, referring to the next trimmed element.
Parameters:
iOrientation
Orientation
iRank
index of the feature
o SetNumberOfIntersections
public virtual HRESULT SetNumberOfIntersections( const CATISpecObject_var iElem,
const int iNbIntersections) = 0
Sets the number of intersections with the other elements, in Pieces mode. If iNumberOfIntersections<0, No check of the number of intersections at Update
Parameters:
iElem
trimmed feature
iNumberOfIntersections
Number of intersections
o SetPortionToKeep
public virtual HRESULT SetPortionToKeep( const int iPortionNumber,
const int iRank) = 0
Sets a portion to keep number in Pieces mode.
Parameters:
iPortionNumber
Index of portion to keep on the element
iRank
Index of the trimmed element
o SetPreviousOrientation
public virtual HRESULT SetPreviousOrientation(CATGSMOrientation iOrientation,
int iRank) = 0
Sets the orientation used to compute the feature, referring to the previous trimmed element.
Parameters:
iOrientation
Orientation
iRank
index of the feature
o SetSecondElem
public virtual HRESULT SetSecondElem( const CATISpecObject_var iElem) = 0
Deprecated:
V5R17 CATIGSMTrim#SetElem Sets the second feature to trim (a curve or surface).
Parameters:
iElem
second feature to cut
o SetSecondOrientation
public virtual HRESULT SetSecondOrientation(CATGSMOrientation iOrientation) = 0
Deprecated:
V5R17 CATIGSMTrim#SetPreviousOrientation(1) Sets the second orientation used to compute the trim. Orientation specifies kept parts of second feature.

When trimming surfaces :
- If CATGSMSameOrientation: Kept parts are specified by the "natural" normal to the first feature
- If CATGSMInvertOrientation: Kept parts are specified by the inverse of the "natural" normal to the first feature

When trimming curves (without support):
- If CATGSMSameOrientation: Kept parts are from beginning of the curve to the first intersection,
and ,if there is one, from the second to the third intersection and so on until the end of the curve...
- If CATGSMInvertOrientation: Kept parts are from the first intersection to the second (if there is one),
and, if there is one, from the third to the fourth and so on until the end of the curve...

When trimming curves on support:
- If CATGSMSameOrientation:
Kept parts of the second curve are specified by the result of the cross product : normal(support surface)^tangent(first curve)
- If CATGSMInvertOrientation:
Kept parts of the second curve are specified by the inverse of the result of the cross product : normal(support surface)^tangent(first curve)

Parameters:
iOrientation
second orientation used to compute the trim
o SetSimplify
public virtual HRESULT SetSimplify(CATBoolean iMode) = 0
Sets or unsets the simplification of the resulting topology.
Parameters:
iMode
Simplification option on (TRUE) or off (FALSE)
o SetSupportElem
public virtual HRESULT SetSupportElem( const CATISpecObject_var iElem) = 0
Sets the support of the curves to trim (optional).
Parameters:
iElem
Support surface

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

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