All Frameworks Class Hierarchy This Framework Previous Next Indexes
FittingInterfaces Interface CATIShot
System.IUnknown
|
+---System.IDispatch
|
+---System.CATBaseUnknown
|
+---CATIShot
Usage: you must use this class as is. You should never derive it.
interface CATIShot
The interface to access a CATIShot.
Role: A CATIShot (or shot) is the base element that CATISampled objects are composed of. For example, when considering a
CATITrack, each recorded position is a shot.
Method Index
- o
GetApplicativeDatas(int&,double*&)
- Retrieves data to the related objects in the previous API.
- o
GetApplicativeId(unsigned int&)
- Retrieves how special characteristics for different objects when creating a
shot.
- o
GetDirectionalDatas(void*&)
- Retrieves the compass position related to the shot
- o
GetDuration(double&)
- Retrieves the duration (time) associated to a shot.
- o
GetPositionData(double*,int&)
- Retrieves the positional/directional information related to the shot.
- o
ResetDuration()
- Resets the duration (time) associated to a shot.
- o
SetApplicativeDatas(int,double*)
- Sets data to the related objects in the previous API.
- o
SetApplicativeId(unsigned int)
- Sets special characteristics for different objects when creating a
shot.
- o
SetDirectionalDatas(void*)
- Sets the compass position for the shot
- o
SetDuration(double)
- Sets the duration (time) associated to a shot.
- o
SetPositionData(double*,int)
- Sets the positional/directional information related to the shot.
Methods
o GetApplicativeDatas
public virtual HRESULT GetApplicativeDatas( | int& | oSize, |
| double*& | oDatas) =0 |
-
Retrieves data to the related objects in the previous API. For example: the zoom
for a camera.
- Parameters:
-
- oSize
- The size/number of elements contained in oDatas
- iDatas
- A set of data values (stored as doubles) retrieved.
o GetApplicativeId
public virtual HRESULT GetApplicativeId( | unsigned int& | oId) =0 |
-
Retrieves how special characteristics for different objects when creating a
shot. Again this is for different objects such as a camera. It is
recommended for it to be set so that the correct interpolation can be
determined between shots.
- Parameters:
-
- oId
- The value of the id
o GetDirectionalDatas
public virtual HRESULT GetDirectionalDatas( | void*& | oDatas) =0 |
-
Retrieves the compass position related to the shot
- Parameters:
-
- oDatas
-
- Compass (or Manipulator) Position; it is relative to the object
position
o GetDuration
public virtual HRESULT GetDuration( | double& | oTime) =0 |
-
Retrieves the duration (time) associated to a shot. The duration of a
shot is the amount of time needed to travel from the previous shot to
the current shot. Some key things to note are:
- The first shot should have a duration of zero.
- The value of the duration is a positive real number. Hence,
0.454 & 1345 are legal while -18 is not.
- Parameters:
-
- oTime
- The duration of a shot.
o GetPositionData
public virtual HRESULT GetPositionData( | double* | oPosDatas, |
| int& | oSize)=0 |
-
Retrieves the positional/directional information related to the shot.
This method doesnt return information for Generic Shots because the Generic shots
do not cantain positional data. For ShotDouble we get 24 values for Shot Simple we get 12 values
and for Shot Points we get 9 values.
The caller should create an array of sufficient size
- Parameters:
-
- oPosDatas
- If the shot is for a Track then it returns the shot information.
- Compass (or Manipulator) Position which is relative to the object
position and the Object Position that is relative to the start
of the track.
- oSize
- The size of the list of double that is returned
o ResetDuration
public virtual HRESULT ResetDuration( | )=0 |
-
Resets the duration (time) associated to a shot.
Role: When reseting a shot's time, data values are unset (or deleted).
Then the next time GetDuration is called, the duration will be recalculated.
o SetApplicativeDatas
public virtual HRESULT SetApplicativeDatas( | int | iSize, |
| double* | iDatas) =0 |
-
Sets data to the related objects in the previous API. For example: the zoom
for a camera.
- Parameters:
-
- iSize
- The size/number of elements contained in iDatas
- iDatas
- A set of data values (stored as doubles) to be stored.
o SetApplicativeId
public virtual HRESULT SetApplicativeId( | unsigned int | iId) =0 |
-
Sets special characteristics for different objects when creating a
shot. Again this is for different object types such as a camera. It is
recommended for it to be set so that the correct interpolation can be
determined between shots.
- Parameters:
-
- iId
- The number of the id to set.
o SetDirectionalDatas
public virtual HRESULT SetDirectionalDatas( | void* | iDatas) =0 |
-
Sets the compass position for the shot
- Parameters:
-
- iDatas
-
- Compass Position is set, it is relative to the object position
o SetDuration
public virtual HRESULT SetDuration( | double | iTime) =0 |
-
Sets the duration (time) associated to a shot. The duration of a
shot is the amount of time needed to travel from the previous shot to
the current shot. Some key things to note are:
- The first shot should have a duration of zero.
- The value of the duration is a positive real number. Hence,
0.454 & 1345 are legal while -18 is not.
- Parameters:
-
- iTime
- The duration of a shot.
o SetPositionData
public virtual HRESULT SetPositionData( | double* | iPosDatas, |
| int | iSize)=0 |
-
Sets the positional/directional information related to the shot.
This method doesnt set information for Generic Shots because the Generic shots
do not cantain positional data. For ShotDouble we get 24 values for Shot Simple
we get 12 values and for Shot Points we get 9 values.
- Parameters:
-
- iPosDatas
- If the shot is for a Track then it sets the shot information.
- iPosDatas contains Compass Position which is relative to the object
position and the Object Position that is relative to the start
of the track.
- iSize
- This is the size of double
This object is included in the file: CATIShot.h
If needed, your Imakefile.mk should include the module: CATFittingInterfaces