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 const &in_capture_path = HPS::ComponentPath())

Activates this capture.

Parameters

in_capture_path – The capture path to operate on.

Returns

the View.

Capture()

The default constructor creates an uninitialized Capture object. The Type() function will return Type::None.

Capture(Component const &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.

Parameters

in_that – The source Component to copy.

Capture(Exchange::Capture &&in_that)

The move constructor creates an Exchange::Capture by transferring the underlying object of the rvalue reference to this Exchange::Capture.

Parameters

in_that – An rvalue reference to an Exchange::Capture to take the underlying object from.

Capture(Exchange::Capture const &in_that)

The copy constructor creates an Exchange::Capture object that shares the underlying smart-pointer of the source Exchange::Capture.

Parameters

in_that – The source Exchange::Capture to copy.

Capture(HPS::Capture const &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.

Parameters

in_that – The source HPS::Capture to copy.

A3DEntity *GetExchangeEntity() const

Gets the A3DEntity pointer corresponding to this Exchange::Capture.

Returns

The A3DEntity pointer corresponding to this Exchange::Capture.

inline virtual HPS::Type ObjectType() const

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).

Returns

The declared type of the object in question, which may differ from the true, underlying type.

Capture &operator=(Exchange::Capture &&in_that)

The move assignment operator transfers the underlying object of the rvalue reference to this Exchange::Capture.

Parameters

in_that – An rvalue reference to an Exchange::Capture to take the underlying object from.

Returns

A reference to this Exchange::Capture.

virtual ~Capture()

Public Static Attributes

static const HPS::Type staticType = HPS::Type::ExchangeCapture