#include <sprk_parasolid.h>

Public Member Functions | |
Component () | |
Component (HPS::Component const &in_that) | |
Component (Parasolid::Component const &in_that) | |
Component (Parasolid::Component &&in_that) | |
ParasolidEntity | GetParasolidEntity () const |
HPS::Type | ObjectType () const |
Component & | operator= (Parasolid::Component &&in_that) |
void | Tessellate (Parasolid::FacetTessellationKit const &in_facet_options, Parasolid::LineTessellationKit const &in_line_options) |
virtual | ~Component () |
![]() | |
void | AddKey (Key const &in_key) |
void | AddOwner (Component &in_owner, IncludeKey const &in_include=IncludeKey()) |
void | AddReference (Component &in_reference) |
virtual void | Assign (Component const &in_that) |
Component () | |
Component (Component const &in_that) | |
Component (Component &&in_that) | |
void | Delete () |
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 |
![]() | |
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 () |
HPS::Type | Type () const |
Detailed Description
The Component class is a smart pointer. It represents a variety of Parasolid components. The primary purpose of this class is simply to provide access to the underlying ParasolidEntity object for use by Parasolid library functions.
Constructor & Destructor Documentation
HPS::Parasolid::Component::Component | ( | ) |
The default constructor creates an uninitialized Parasolid::Component object. The Type() function will return Type::None.
HPS::Parasolid::Component::Component | ( | HPS::Component const & | in_that | ) |
This constructor creates an Parasolid::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 a Parasolid::Component object. Otherwise the copy will fail and the resulting Parasolid::Component will be invalid.
- Parameters
-
in_that The source Component to copy.
HPS::Parasolid::Component::Component | ( | Parasolid::Component const & | in_that | ) |
The copy constructor creates an Parasolid::Component object that shares the underlying smart-pointer of the source Parasolid::Component.
- Parameters
-
in_that The source Parasolid::Component to copy.
HPS::Parasolid::Component::Component | ( | Parasolid::Component && | in_that | ) |
The move constructor creates a Parasolid::Component by transferring the underlying object of the rvalue reference to this Parasolid::Component.
- Parameters
-
in_that An rvalue reference to an Parasolid::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
ParasolidEntity HPS::Parasolid::Component::GetParasolidEntity | ( | ) | const |
|
inlinevirtual |
This function returns the type the object, as declared. This does not necessarily give the true type of the underlying object.
- Returns
- The declared type of the object in question, which may differ from the true, underlying type.
Reimplemented from HPS::Component.
Component& HPS::Parasolid::Component::operator= | ( | Parasolid::Component && | in_that | ) |
The move assignment operator transfers the underlying object of the rvalue reference to this Parasolid::Component.
- Parameters
-
in_that An rvalue reference to a Parasolid::Component to take the underlying object from.
- Returns
- A reference to this Parasolid::Component.
void HPS::Parasolid::Component::Tessellate | ( | Parasolid::FacetTessellationKit const & | in_facet_options, |
Parasolid::LineTessellationKit const & | in_line_options | ||
) |
The documentation for this class was generated from the following file:
- include/sprk_parasolid.h