#include <sprk_dwg.h>

Public Member Functions | |
Component () | |
Component (HPS::Component const &in_that) | |
Component (DWG::Component const &in_that) | |
Component (DWG::Component &&in_that) | |
DWGObjectID * | GetDWGObjectID () const |
HPS::Type | ObjectType () const |
Component & | operator= (DWG::Component &&in_that) |
virtual | ~Component () |
![]() | |
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) |
![]() | |
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::DWGComponent |
![]() | |
static const HPS::Type | staticType = HPS::Type::Component |
![]() | |
static const HPS::Type | staticType = HPS::Type::None |
Detailed Description
The Component class is a smart pointer. It represents a variety of DWG components. The primary purpose of this class is simply to provide access to the underlying DWG object for use by DWG library functions.
Constructor & Destructor Documentation
HPS::DWG::Component::Component | ( | ) |
The default constructor creates an uninitialized DWG::Component object. The Type() function will return Type::None.
HPS::DWG::Component::Component | ( | HPS::Component const & | in_that | ) |
This constructor creates an DWG::Component 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 DWG::Component object. Otherwise the copy will fail and the resulting DWG::Component will be invalid.
- Parameters
-
in_that The source Component to copy.
HPS::DWG::Component::Component | ( | DWG::Component const & | in_that | ) |
The copy constructor creates an DWG::Component object that shares the underlying smart-pointer of the source DWG::Component.
- Parameters
-
in_that The source DWG::Component to copy.
HPS::DWG::Component::Component | ( | DWG::Component && | in_that | ) |
The move constructor creates an DWG::Component by transferring the underlying object of the rvalue reference to this DWG::Component.
- Parameters
-
in_that An rvalue reference to an DWG::Component to take the underlying object from.
|
virtual |
Releases a reference to this Component. The Component will not be deleted unless the final reference is destroyed.
Reimplemented from HPS::Component.
Member Function Documentation
DWGObjectID* HPS::DWG::Component::GetDWGObjectID | ( | ) | const |
Component& HPS::DWG::Component::operator= | ( | DWG::Component && | in_that | ) |
The move assignment operator transfers the underlying object of the rvalue reference to this DWG::Component.
- Parameters
-
in_that An rvalue reference to an DWG::Component to take the underlying object from.
- Returns
- A reference to this DWG::Component.
The documentation for this class was generated from the following file:
- include/sprk_dwg.h