#include <sprk_exchange.h>

Public Member Functions | |
HPS::View | Activate (HPS::ComponentPath const &in_capture_path=HPS::ComponentPath()) |
Capture () | |
Capture (Component const &in_that) | |
Capture (HPS::Capture const &in_that) | |
Capture (Exchange::Capture const &in_that) | |
Capture (Exchange::Capture &&in_that) | |
A3DEntity * | GetExchangeEntity () const |
HPS::Type | ObjectType () const |
Capture & | operator= (Exchange::Capture &&in_that) |
![]() | |
View | Activate () |
Capture () | |
Capture (Component const &in_that) | |
Capture (Capture const &in_that) | |
Capture (Capture &&in_that) | |
Capture & | operator= (Capture &&in_that) |
![]() | |
void | AddKey (Key const &in_key) |
void | AddOwner (Component &in_owner, IncludeKey const &in_include=IncludeKey()) |
void | AddReference (Component &in_reference) |
bool | AddTransform (MatrixKit const &in_transform) |
virtual void | Assign (Component const &in_that) |
Component () | |
Component (Component const &in_that) | |
Component (Component &&in_that) | |
Component | CopyTo (HPS::Component const &in_new_owner) |
void | Delete (HPS::Component::DeleteMode mode=HPS::Component::DeleteMode::Standard) |
bool | Equals (Component const &in_that) const |
void | Flush () |
MetadataArray | GetAllMetadata () const |
ComponentArray | GetAllSubcomponents (ComponentType in_type) const |
ComponentType | GetComponentType () const |
KeyArray | GetKeys () const |
Metadata | GetMetadata (char const *in_name) const |
UTF8 | GetName () const |
ComponentArray | GetOwners () const |
ComponentArray | GetReferences () const |
ComponentArray | GetReferrers () const |
ComponentArray | GetSubcomponents () const |
bool | HasComponentType (ComponentType in_mask) const |
bool | operator!= (Component const &in_that) const |
Component & | operator= (Component const &in_that) |
Component & | operator= (Component &&in_that) |
bool | operator== (Component const &in_that) const |
bool | SetName (char const *in_new_name) |
bool | SetTransform (MatrixKit const &in_transform) |
virtual | ~Component () |
![]() | |
Sprocket (Sprocket &&in_that) | |
![]() | |
virtual bool | Empty () const |
intptr_t | GetClassID () const |
intptr_t | GetInstanceID () const |
bool | HasType (HPS::Type in_mask) const |
Object (Object const &that) | |
Object (Object &&in_that) | |
Object & | operator= (Object const &other_object) |
Object & | operator= (Object &&in_that) |
virtual void | Reset () |
virtual HPS::Type | Type () const |
Static Public Attributes | |
static const HPS::Type | staticType = HPS::Type::ExchangeCapture |
![]() | |
static const HPS::Type | staticType = HPS::Type::Capture |
![]() | |
static const HPS::Type | staticType = HPS::Type::Component |
![]() | |
static const HPS::Type | staticType = HPS::Type::None |
Detailed Description
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.
Constructor & Destructor Documentation
◆ Capture() [1/5]
HPS::Exchange::Capture::Capture | ( | ) |
◆ Capture() [2/5]
HPS::Exchange::Capture::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() [3/5]
HPS::Exchange::Capture::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.
◆ Capture() [4/5]
HPS::Exchange::Capture::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() [5/5]
HPS::Exchange::Capture::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.
Member Function Documentation
◆ GetExchangeEntity()
A3DEntity* HPS::Exchange::Capture::GetExchangeEntity | ( | ) | const |
Gets the A3DEntity pointer corresponding to this Exchange::Capture.
- Returns
- The A3DEntity pointer corresponding to this Exchange::Capture.
◆ ObjectType()
|
inlinevirtual |
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.
Reimplemented from HPS::Capture.
◆ operator=()
Capture& HPS::Exchange::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.
The documentation for this class was generated from the following file:
- include/sprk_exchange.h