HPS::Capture Class Reference
#include <sprk.h>
Inheritance diagram for HPS::Capture:

Public Member Functions | |
View | Activate () |
Capture () | |
Capture (Component const &in_that) | |
Capture (Capture const &in_that) | |
Capture (Capture &&in_that) | |
HPS::Type | ObjectType () const |
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::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 a capture, i.e., a collection of visibility settings, material settings, transformation settings, and camera, for a CADModel.
Constructor & Destructor Documentation
◆ Capture() [1/4]
HPS::Capture::Capture | ( | ) |
◆ Capture() [2/4]
HPS::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 a Capture object. Otherwise the copy will fail and the resulting Capture will be invalid.
- Parameters
-
in_that The source Component to copy.
◆ Capture() [3/4]
HPS::Capture::Capture | ( | Capture const & | in_that | ) |
◆ Capture() [4/4]
HPS::Capture::Capture | ( | Capture && | in_that | ) |
Member Function Documentation
◆ Activate()
View HPS::Capture::Activate | ( | ) |
◆ 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::Component.
Reimplemented in HPS::Exchange::Capture, and HPS::DWG::Layout.
◆ operator=()
The documentation for this class was generated from the following file:
- include/sprk.h