PLMValidationInterfaces Interface CATIMarker3DArrow

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


interface CATIMarker3DArrow

Interface to manage an 3D Arrow.

Errors not documented on each method:

E_OUTOFMEMORY
One memory allocation fails.
E_UNEXPECTED
There is an unexpected failure.


Method Index


o GetEndingPoint(CATMathPoint&)
Retrieves the Ending Point of the Marker.
o GetPointingPoint(CATMathPoint&)
Retrieves the Pointing Point of the Marker.
o IsFilled(CATBoolean&)
Retrieves the filled status of the Marker.
o SetEndingPoint(CATMathPoint&)
Sets the Ending Point of the Marker.
o SetFilled(CATBoolean&)
Sets the filled status of the Marker
o SetPointingPoint(CATMathPoint&)
Sets the Pointing Point of the Marker.

Methods


o GetEndingPoint
public virtual GetEndingPoint( oPoint)
Retrieves the Ending Point 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 GetPointingPoint
public virtual GetPointingPoint( oPoint)
Retrieves the Pointing Point 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 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 SetEndingPoint
public virtual SetEndingPoint( iPoint)
Sets the Ending Point 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 SetPointingPoint
public virtual SetPointingPoint( iPoint)
Sets the Pointing Point 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.

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

Copyright © 1999-2014, Dassault Systèmes. All rights reserved.