PLMValidationInterfaces Interface CATIMarker3DFactory
Usage: an implementation of this interface is supplied and you must use it as is. You should not reimplement it.
interface CATIMarker3DFactory
Interface to manage 3D Marker which belong to a Review.
Errors not documented on each method:
- E_OUTOFMEMORY
- One memory allocation fails.
- E_UNEXPECTED
- There is an unexpected failure.
Method Index
- o
CreateMarker3D(CATString,IID&,void**)
- Creates a 3D Marker.
- o
ListMarker3Ds(CATListValCATBaseUnknown_var&)
- Retrieves the list of 3D Markers which belong to a Review.
Methods
o CreateMarker3D
| public virtual CreateMarker3D( | | iMarkerType, |
| const | iIID, |
| | opiMarker) |
-
Creates a 3D Marker.
- Parameters:
-
- iMarkerType
- The type of the 3D Marker.
Legal values:
- "3DMarkerText"
- The Marker is a 3D Marker Text.
- "3DMarkerArrow"
- The Marker is a 3D Marker Arrow.
- "3DMarkerCircle"
- The Marker is a 3D Marker Circle.
- iIID
- The IID of the interface.
- opiMarker
- [out, CATBaseUnknown#Release] The created Marker.
Legal values:
- Valid
- The Marker is valid.
- NULL
- The Marker is not created.
- Returns:
- HRESULT
Legal values:
- S_OK
- The Marker is succesfully created.
- E_FAIL
- The Review is not alive.
o ListMarker3Ds
| public virtual ListMarker3Ds( | | oMarker3DsList) |
-
Retrieves the list of 3D Markers which belong to a Review.
- Parameters:
-
- oMarker3DsList
- The list of 3D Markers.
Legal values:
- Empty
- There is no 3D Markers or there is an error.
- Filled
- There are some 3D Markers (in this case the order is not specified).
- Returns:
- HRESULT
Legal values:
- S_OK
- The list is successfully returned.
- E_FAIL
- The Review is not alive.
This object is included in the file: CATIMarker3DFactory.h
If needed, your Imakefile.mk should include the module: PLMValidationItf
Copyright © 1999-2014, Dassault Systèmes. All rights reserved.