HPS::Exchange::Capture
- class HPS.Exchange.Capture : public HPS.Capture
The Capture class is a smart pointer. It represents an A3DMkpView in Exchange. The primary purpose of this class is simply to provide access to the underlying A3DMkpView pointer for use by Exchange library functions.
Public Functions
- HPS.View Activate (HPS.ComponentPath in_capture_path)
Activates this capture.
- Param in_capture_path
The capture path to operate on.
- Return
the View.
- Capture ()
The default constructor creates an uninitialized Capture object. The Type() function will return Type.None.
- Capture (HPS.Capture in_that)
This constructor creates an Exchange.Capture object that shares the underlying smart-pointer of the source HPS.Capture. The copy will only be successful if the source component is really an upcast of an Exchange.Capture object. Otherwise the copy will fail and the resulting Exchange.Capture will be invalid.
- Param in_that
The source HPS.Capture to copy.
- Capture (HPS.Component in_that)
This constructor creates a Capture object that shares the underlying smart-pointer of the source Component. The copy will only be successful if the source component is really an upcast of an Exchange.Capture object. Otherwise the copy will fail and the resulting Exchange.Capture will be invalid.
- Param in_that
The source Component to copy.
- Capture (HPS.Exchange.Capture in_that)
This constructor creates an Exchange.Capture object that shares the underlying smart-pointer of the source HPS.Capture. The copy will only be successful if the source component is really an upcast of an Exchange.Capture object. Otherwise the copy will fail and the resulting Exchange.Capture will be invalid.
- Param in_that
The source HPS.Capture to copy.
- override void Dispose ()
- IntPtr GetExchangeEntity ()
Gets the A3DEntity pointer corresponding to this Exchange.Capture.
- Return
The A3DEntity pointer corresponding to this Exchange.Capture.
- override HPS.Type ObjectType ()
This function returns the type the object, as declared (if the object is derived, this does not give the true type of the derived object).
- Return
The declared type of the object in question, which may differ from the true, underlying type.
