PLMValidationInterfaces Interface CATIMarker3DCircle
Usage: an implementation of this interface is supplied and you must use it as is. You should not reimplement it.
interface CATIMarker3DCircle
Interface to manage an 3D Circle.
Errors not documented on each method:
- E_OUTOFMEMORY
- One memory allocation fails.
- E_UNEXPECTED
- There is an unexpected failure.
Method Index
- o
GetCenter(CATMathPoint&)
- Retrieves the Center of the Marker.
- o
GetRadius(double&)
- Retrieves the Radius of the Marker.
- o
IsFilled(CATBoolean&)
- Retrieves the filled status of the Marker.
- o
SetCenter(CATMathPoint&)
- Sets the Center of the Marker.
- o
SetFilled(CATBoolean&)
- Sets the filled status of the Marker
- o
SetRadius(double&)
- Sets the Radius of the Marker.
Methods
o GetCenter
| public virtual GetCenter( | | oPoint) |
-
Retrieves the Center of the Marker.
- Parameters:
-
- oPoint
- The Point.
- Returns:
- HRESULT
Legal values:
- S_OK
- The Point is successfully returned.
- E_FAIL
- The Point is not returned.
o GetRadius
| public virtual GetRadius( | | oRadius) |
-
Retrieves the Radius of the Marker.
- Parameters:
-
- oRadius
- The Radius.
- Returns:
- HRESULT
Legal values:
- S_OK
- The Radius is successfully returned.
- E_FAIL
- The Radius is not returned.
o IsFilled
| public virtual IsFilled( | | oFilled) |
-
Retrieves the filled status of the Marker.
- Parameters:
-
- oFilled
- The status.
Legal values:
- true
- The Marker is filled.
- false
- The Marker is unfilled.
- Returns:
- HRESULT
Legal values:
- S_OK
- The status is successfully returned.
- E_FAIL
- The status is not returned.
o SetCenter
| public virtual SetCenter( | | iPoint) |
-
Sets the Center of the Marker.
- Parameters:
-
- iPoint
- The Point.
- Returns:
- HRESULT
Legal values:
- S_OK
- The Point is successfully set.
- E_FAIL
- The Point is not set.
o SetFilled
| public virtual SetFilled( | | iFilled) |
-
Sets the filled status of the Marker
- Parameters:
-
- iFilled
- The status.
Legal values:
- true
- The Marker status is filled.
- false
- The Marker status is unfilled.
- Returns:
- HRESULT
Legal values:
- S_OK
- The status is successfully set.
- E_FAIL
- The status is not set.
o SetRadius
| public virtual SetRadius( | | iRadius) |
-
Sets the Radius of the Marker.
- Parameters:
-
- iRadius
- The Radius.
- Returns:
- HRESULT
Legal values:
- S_OK
- The Radius is successfully set.
- E_FAIL
- The Radius is not set.
This object is included in the file: CATIMarker3DCircle.h
If needed, your Imakefile.mk should include the module: PLMValidationItf
Copyright © 1999-2014, Dassault Systèmes. All rights reserved.