InteractiveInterfaces Interface CATISelectionSetElement
Usage: an implementation of this interface is supplied and you must use it as is. You should not reimplement it.
interface CATISelectionSetElement
Interface to handle a Selection Set element.
Role: A Selection Set element is managed by .
A Selection Set contains elements. An element is a feature
or a sub-element (face, edge, vertex, ...) and is refered by a CATPathElement. As the element
can change with the design, the path can be modified. So the path that is used the first
time to create the Selection Set element is named initial path.
Method Index
- o
Compare(CATPathElement*)
- Compares the path of this and another path.
- o
Compare(CATISelectionSetElement*)
- Compares this with another Selection Set element.
- o
ComputePath(CATPathElement*&,CATPathElement*)
- Computes the initial path of the Selection Set element.
- o
ComputePathWithContext(CATLISTP(CATPathElement)&,CATPathElement*)
- Computes the updated path of the Selection Set element.
- o
GetPointedElement(CATBaseUnknown*&)
- Returns pointed element.
Methods
o Compare
| public virtual Compare( | const | iPathElement) |
-
Compares the path of this and another path.
Role:
This method compares the initial path of this and another path.
- Parameters:
-
- iPathElement
- The path of the element to be compared with.
- Returns:
- The status.
Legal values:
- 0: the two paths are identical.
- 1: the two paths are different.
o Compare
| public virtual Compare( | const | iSetElement) |
-
Compares this with another Selection Set element.
Role:
Returns the result of the comparison of the two Selection Set elements.
This comparison is made on the initial paths returned by
. The elements can be identical even if they are not in the same Selection Set.
- Parameters:
-
- iSetElement
- The Selection Set element to be compared with.
- Returns:
- The status.
Legal values:
- 0: the two Selection Set element are identical.
- 1: the two Selection Set element are different.
o ComputePath
| public virtual ComputePath( | | oElementPath, |
| | iDocInstancePath | =NULL) |
-
Computes the initial path of the Selection Set element.
- Parameters:
-
- oElementPath
- The initial path of this.
The path can be relative to the document or an absolute path, depending on the content of the value
of iDocInstancePath.
- iDocInstancePath
- The path of the instance of the document containing the Selection Set which includes this, or NULL.
- NULL (the default value) if you want that the returned path is relative to the document.
- the path of the instance of the document containing the Selection Set if you want that
the returned path of the element is an absolute path in the Product context.
- Returns:
- Error code.
Legal values:
- E_FAIL: if the path is not computed.
- S_OK: if the path is computed.
o ComputePathWithContext
| public virtual ComputePathWithContext( | | oListElementPath, |
| | iDocInstancePath | =NULL) |
-
Computes the updated path of the Selection Set element.
Role: The
method returns the initial path of the Selection Set element (the one used in the
method) while the ComputePathWithContext method returns the path in the last feature containing the element.
For example if a face has been created in a feature and this feature has been absorbed by another feature,
this method retrieves the path of the element in the last feature.
- Parameters:
-
- oListElementPath
- The paths of this, updated with the context.
Note that it is possible to have several paths for a Selection Set element : for example if a face is pointed by a
Selection Set element and this face is divided in several faces by a pocket or another feature
this method returns the paths of all the faces.
If the Selection Set element is not visible, the path is nul.
Release is needed on each element of the list except if nul.
The path can be relative to the document or an absolute path, depending on the content of the value
of iDocInstancePath.
- iDocInstancePath
- The path of the instance of the document containing the Selection Set which includes this, or NULL.
- NULL (the default value) if you want that the returned path is relative to the document.
- the path of the instance of the document containing the Selection Set if you want that
the returned path of the element is an absolute path in the Product context.
- Returns:
- Error code.
Legal values:
- E_FAIL: if the path is not computed. In this case, you can retrieve the error
using the CATError::CATGetLastError method. On this error, you can get the message using
the GetNLSMessage on the error to have more information.
Do not forget to release the error then.
- S_OK: if the path is computed.
o GetPointedElement
| public virtual GetPointedElement( | | oPointedElement) |
-
Returns pointed element.
Role: This method retrieves the element pointed by this (only if in same document).
- Returns:
- Error code.
Legal values:
- E_FAIL: the pointed element has not been retrieved.
- S_OK: the pointed element has been retrieved.
This object is included in the file: CATISelectionSetElement.h
If needed, your Imakefile.mk should include the module: CATInteractiveInterfaces
Copyright © 1999-2014, Dassault Systèmes. All rights reserved.