All Frameworks Class Hierarchy This Framework Previous Next Indexes
ProductStructure Interface CATIProductInSession
System.IUnknown
|
+---System.IDispatch
|
+---System.CATBaseUnknown
|
+---ProductStructure.CATIProduct
|
+---CATIProductInSession
Usage: an implementation of this interface is supplied and you must use it as is. You should not reimplement it.
interface CATIProductInSession
Interface used to manipulate temporary data about a product.
Note: A product is able to have more than one representation. Only
one is active (this notion has sense in session only ).
Method Index
- o
GetActiveShapeName(CATUnicodeString&,CATRepMode&,CATBoolean)
- Returns the name of the active representation.
- o
GetActiveShapeRep()
- Returns the active representation.
- o
GetActiveShapeRep(CATILinkableObject_var&,CATRepMode&,CATBoolean)
- Returns the active representation.
- o
SetActiveShapeRep(CATUnicodeString&,CATBoolean,CATBoolean,CATRepMode&,CATBoolean,CATBoolean)
- Activates a representation by its name.
Methods
o GetActiveShapeName
-
Returns the name of the active representation.
- Parameters:
-
- oaName
- name of the representation.
- Id
- The behavior of the representation.
Legal values:
CATPrd3D if the representation is a 3D one,
CATPrd2D if the representation is a 2D one,
or CATPrdText if the representation is a text one.
- InCtxt
- do not use
o GetActiveShapeRep
-
Returns the active representation.
- Returns:
- shape associated to the active representation.
o GetActiveShapeRep
public virtual HRESULT GetActiveShapeRep( | CATILinkableObject_var& | oShape, |
| const CATRepMode& | Id | = CATPrd3D, |
| const CATBoolean | iInCtxt | = TRUE)=0 |
-
Returns the active representation.
- Parameters:
-
- oShape
- shape associated to the active representation.
- Id
- The behavior of the representation.
Legal values:
CATPrd3D if the representation is a 3D one,
CATPrd2D if the representation is a 2D one,
or CATPrdText if the representation is a text one.
- iInCtxt
- do not use
- Returns:
- an HRESULT
Legal values: S_OK if the shape is found.
o SetActiveShapeRep
-
Activates a representation by its name.
- Parameters:
-
- iShapeName
- name of the representation associated to the product.
- iDoDispatch
- do not use
- iStartUpMode
- TRUE to visualize all instances of the StartUp of this.
- Id
- The behavior of the added representation.
Legal values:
CATPrd3D if the representation is a 3D one,
CATPrd2D if the representation is a 2D one,
or CATPrdText if the representation is a text one.
- iInCtxt
- do not use
This object is included in the file: CATIProductInSession.h
If needed, your Imakefile.mk should include the module: CATProductStructure1