SUAPI-CppWrapper
C++WrapperforSketchUpCAPI
Public Member Functions
CW::Group Class Reference
+ Inheritance diagram for CW::Group:

Public Member Functions

 Group ()
 
 Group (SUGroupRef group, bool attached=true)
 
 Group (const ComponentInstance &instance)
 
 Group (const Group &other)
 
 ~Group ()
 
Groupoperator= (const Group &other)
 
SUGroupRef ref () const
 
 operator SUGroupRef () const
 
 operator SUGroupRef * ()
 
ComponentDefinition definition () const
 
Entities entities () const
 
String name () const
 
void name (const String &string)
 
Transformation transformation () const
 
void transformation (const Transformation &transform)
 
- Public Member Functions inherited from CW::ComponentInstance
 ComponentInstance ()
 
 ComponentInstance (SUComponentInstanceRef instance, bool attached=true)
 
 ComponentInstance (const ComponentInstance &other)
 
 ComponentInstance (const ComponentInstance &other, SUComponentInstanceRef instance_ref)
 
 ~ComponentInstance ()
 
ComponentInstanceoperator= (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 ()
 
DrawingElementoperator= (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...
 
Entityoperator= (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< AttributeDictionaryattribute_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
 

Additional Inherited Members

- Protected Member Functions inherited from CW::ComponentInstance
SUComponentInstanceRef copy_reference (const ComponentInstance &other)
 
- 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 45 of file Group.hpp.

Constructor & Destructor Documentation

CW::Group::Group ( )

Construct a new, empty Group object.

Definition at line 71 of file Group.cpp.

CW::Group::Group ( SUGroupRef  group,
bool  attached = true 
)

Construct a Group from an existing SUGroupRef object. Groups must always be attached to a parent (there is no release function for Groups)

Definition at line 76 of file Group.cpp.

CW::Group::Group ( const ComponentInstance instance)

Construct a Group from instance object. If the instance is not a group, you will get errors, as the constructor does not check for this.

Definition at line 80 of file Group.cpp.

CW::Group::Group ( const Group other)

Copy constructor

Definition at line 87 of file Group.cpp.

CW::Group::~Group ( )

Destructor

Definition at line 92 of file Group.cpp.

Member Function Documentation

ComponentDefinition CW::Group::definition ( ) const

Return the ComponentDefinition of the Group.

Definition at line 117 of file Group.cpp.

Entities CW::Group::entities ( ) const

Return the Entities object of the Group.

Definition at line 128 of file Group.cpp.

String CW::Group::name ( ) const

Return the name of the Group.

Definition at line 138 of file Group.cpp.

void CW::Group::name ( const String string)

Set the name of this Group.

Definition at line 150 of file Group.cpp.

Group & CW::Group::operator= ( const Group other)

Copy assignment operator

Definition at line 99 of file Group.cpp.

SUGroupRef CW::Group::ref ( ) const

Returns the raw SUGroupRef object.

Definition at line 107 of file Group.cpp.

Transformation CW::Group::transformation ( ) const

Return the Transformation object of the group.

Definition at line 160 of file Group.cpp.

void CW::Group::transformation ( const Transformation transform)

Set the Transformation of the group.

Definition at line 170 of file Group.cpp.


The documentation for this class was generated from the following files: