All Frameworks Class Hierarchy This Framework Previous Next Indexes
CATPlantShipInterfaces Interface CATIPspLightPart
System.IUnknown
|
+---CATIPspLightPart
Usage: an implementation of this interface is supplied and you must use it as is. You should not reimplement it.
interface CATIPspLightPart
Interface to manage light objects.
Role: To access light object data.
Method Index
- o
GetDefinition(CATIMovable*,CATListValCATMathPoint&)
- Retrieve the points defining the object.
- o
SetDefinition(CATIMovable*,CATListValCATMathPoint&)
- Set the points defining the light object.
Methods
o GetDefinition
public virtual HRESULT GetDefinition( | const CATIMovable* | iRelAxis, |
| CATListValCATMathPoint& | oListPoints) = 0 |
-
Retrieve the points defining the object.
- Parameters:
-
- iRelAxis
- The relative axis object (NULL means relative to parent).
- oListPoints
- List of points defining object.
- Returns:
- An HRESULT value.
Legal values:
- S_OK
- operation is successful
- E_FAIL
- operation failed
o SetDefinition
public virtual HRESULT SetDefinition( | const CATIMovable* | iRelAxis, |
| const CATListValCATMathPoint& | iListPoints) = 0 |
-
Set the points defining the light object.
- Parameters:
-
- iRelAxis
- The relative axis object (NULL means relative to parent).
- iListPoints
- List of points defining object.
- Returns:
- An HRESULT value.
Legal values:
- S_OK
- operation is successful
- E_FAIL
- operation failed
This object is included in the file: CATIPspLightPart.h