Inheritance diagram for CW::ComponentInstance:
Public Member Functions | |
| ComponentInstance () | |
| ComponentInstance (SUComponentInstanceRef instance, bool attached=true) | |
| ComponentInstance (const ComponentInstance &other) | |
| ComponentInstance (const ComponentInstance &other, SUComponentInstanceRef instance_ref) | |
| ~ComponentInstance () | |
| ComponentInstance & | operator= (const ComponentInstance &other) |
| SUComponentInstanceRef | ref () const |
| operator SUComponentInstanceRef () const | |
| operator SUComponentInstanceRef * () | |
| Transformation | transformation () const |
| void | transformation (const Transformation &tranform) |
| ComponentDefinition | definition () const |
| String | name () const |
| void | name (const String &string) |
| Public Member Functions inherited from CW::DrawingElement | |
| DrawingElement (SUDrawingElementRef drawing_element, bool attached=true) | |
| DrawingElement (const DrawingElement &other, SUDrawingElementRef element_ref=SU_INVALID) | |
| DrawingElement () | |
| DrawingElement & | operator= (const DrawingElement &other) |
| SUDrawingElementRef | ref () const |
| operator SUDrawingElementRef () const | |
| operator SUDrawingElementRef * () | |
| BoundingBox3D | bounds () |
| bool | copy_properties_from (const DrawingElement &element) |
| bool | casts_shadows () const |
| bool | casts_shadows (bool casts_shadows) |
| bool | hidden () const |
| bool | hidden (bool hidden) |
| Layer | layer () const |
| bool | layer (Layer &layer) |
| Material | material () const |
| bool | material (const Material &material) |
| bool | receive_shadows () const |
| bool | receive_shadows (bool receive_shadows) |
| Public Member Functions inherited from CW::Entity | |
| Entity () | |
| Constructor representing a null objject. | |
| Entity (SUEntityRef entity, bool attached=true) | |
| Creates a new Entity object. More... | |
| Entity (const Entity &other, SUEntityRef entity_ref=SU_INVALID) | |
| Copy constructor with an optional parameter for the entity reference. More... | |
| ~Entity () | |
| Destructor. More... | |
| Entity & | operator= (const Entity &other) |
| Copy assignment operator. | |
| operator SUEntityRef () const | |
| operator SUEntityRef * () | |
| SUEntityRef | ref () const |
| bool | attached () const |
| Returns true if the entity is attached to another object. | |
| void | attached (bool attach) |
| Method lets the object know that it has been attached to a model. This is important as it will let the object know that it does not need to "release" the object. More... | |
| std::vector< AttributeDictionary > | attribute_dictionaries () const |
| Returns the AttributeDictionaries collection attached to the entity. More... | |
| AttributeDictionary | attribute_dictionary (const std::string &name) const |
| Returns an attribute dictionary object with a given name that is attached to an Entity. More... | |
| bool | add_dictionary (AttributeDictionary &dict) |
| Adds the AttributeDictionary to the Entity. More... | |
| bool | copy_attributes_from (const Entity &entity) |
| Copies attributes from another Entity object to this one. More... | |
| bool | is_valid () const |
| Checks if the entity is valid. More... | |
| bool | operator! () const |
| Returns true if this entity is not valid. Alias of !is_valid(). | |
| int32_t | entityID () const |
| Retrieve a unique ID assigned to an entity. More... | |
| TypedValue | get_attribute (const std::string &dict_name, const std::string &key, const TypedValue &default_value=TypedValue()) const |
| Retrieves the value of an attribute in the entity's attribute dictionary. More... | |
| TypedValue | get_attribute (const AttributeDictionary &dict, const std::string &key, const TypedValue &default_value=TypedValue()) const |
| Retrieves the value of an attribute in the entity's attribute dictionary. More... | |
| bool | set_attribute (const std::string &dict_name, const std::string &key, const TypedValue &value) |
| Sets the value of an attribute in the given AttributeDictionary object. More... | |
| bool | set_attribute (AttributeDictionary &dict, const std::string &key, const TypedValue &value) |
| Sets the value of an attribute in the given AttributeDictionary object. More... | |
| enum SURefType | entity_type () const |
| Returns the type of the entity. See enum SURefType. | |
| Model | model () const |
| Entities | parent () const |
| int64_t | persistent_id () const |
Protected Member Functions | |
| SUComponentInstanceRef | copy_reference (const ComponentInstance &other) |
Friends | |
| class | Group |
Additional Inherited Members | |
| Protected Attributes inherited from CW::Entity | |
| SUEntityRef | m_entity |
| The C SUEntityRef that this class wraps. | |
| bool | m_attached |
| Indicates whether the Entity has been attached to a model. | |
Detailed Description
Definition at line 41 of file ComponentInstance.hpp.
Constructor & Destructor Documentation
| CW::ComponentInstance::ComponentInstance | ( | ) |
Constructor for null object
Definition at line 59 of file ComponentInstance.cpp.
| CW::ComponentInstance::ComponentInstance | ( | const ComponentInstance & | other | ) |
Copy constructor
Definition at line 69 of file ComponentInstance.cpp.
| CW::ComponentInstance::ComponentInstance | ( | const ComponentInstance & | other, |
| SUComponentInstanceRef | instance_ref | ||
| ) |
Copy constructor for derived classes (Group)
Definition at line 74 of file ComponentInstance.cpp.
| CW::ComponentInstance::~ComponentInstance | ( | ) |
Destructor
Definition at line 79 of file ComponentInstance.cpp.
Member Function Documentation
|
protected |
Creates a copy of the ComponentInstance
Definition at line 45 of file ComponentInstance.cpp.
| ComponentDefinition CW::ComponentInstance::definition | ( | ) | const |
Returns the Component Definition object of this instance.
Definition at line 148 of file ComponentInstance.cpp.
| String CW::ComponentInstance::name | ( | ) | const |
Returns the name of this instance.
Definition at line 159 of file ComponentInstance.cpp.
| void CW::ComponentInstance::name | ( | const String & | string | ) |
Sets the name of this instance.
Definition at line 171 of file ComponentInstance.cpp.
| CW::ComponentInstance::operator SUComponentInstanceRef | ( | ) | const |
Cast to native objects
Definition at line 122 of file ComponentInstance.cpp.
| ComponentInstance & CW::ComponentInstance::operator= | ( | const ComponentInstance & | other | ) |
Copy assignment operator
Definition at line 91 of file ComponentInstance.cpp.
| SUComponentInstanceRef CW::ComponentInstance::ref | ( | ) | const |
Returns the raw SUComponentInstance object.
Definition at line 111 of file ComponentInstance.cpp.
| Transformation CW::ComponentInstance::transformation | ( | ) | const |
Returns the Transformation object applied to this instance.
Definition at line 127 of file ComponentInstance.cpp.
| void CW::ComponentInstance::transformation | ( | const Transformation & | tranform | ) |
Set the transformation applied to this Component Instance
Definition at line 138 of file ComponentInstance.cpp.
The documentation for this class was generated from the following files:
- /home/travis/build/TommyKaneko/Sketchup-API-C-Wrapper/include/SUAPI-CppWrapper/model/ComponentInstance.hpp
- /home/travis/build/TommyKaneko/Sketchup-API-C-Wrapper/src/SUAPI-CppWrapper/model/ComponentInstance.cpp
