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

Public Member Functions

 Layer ()
 
 Layer (SULayerRef layer_ref, bool attached=true)
 
 Layer (const Layer &other)
 
 ~Layer ()
 
Layeroperator= (const Layer &other)
 
SULayerRef ref () const
 
 operator SULayerRef () const
 
 operator SULayerRef * ()
 
bool operator! () const
 
Layer copy () const
 
String name () const
 
void name (const String &string)
 
void name (const std::string &string)
 
- 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 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 40 of file Layer.hpp.

Constructor & Destructor Documentation

CW::Layer::Layer ( )

Constructs a NULL layer.

Definition at line 61 of file Layer.cpp.

CW::Layer::Layer ( SULayerRef  layer_ref,
bool  attached = true 
)

Constructs a Layer object from a pre existing SULayerRef object.

Definition at line 66 of file Layer.cpp.

CW::Layer::Layer ( const Layer other)

Copy Constructor

Definition at line 71 of file Layer.cpp.

CW::Layer::~Layer ( )

Destructor

Definition at line 81 of file Layer.cpp.

Member Function Documentation

Layer CW::Layer::copy ( ) const

Returns a copy of the Layer object, which is not attached to a model.

Definition at line 131 of file Layer.cpp.

String CW::Layer::name ( ) const

Get the name of the layer.

Definition at line 141 of file Layer.cpp.

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

Set the name of the layer.

Definition at line 152 of file Layer.cpp.

bool CW::Layer::operator! ( ) const

Returns whether this is a NULL layer or not.

Definition at line 118 of file Layer.cpp.

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

Copy assignment operator

Definition at line 93 of file Layer.cpp.

SULayerRef CW::Layer::ref ( ) const

Returns the SULayerRef object that this class wraps

Definition at line 109 of file Layer.cpp.


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