Inheritance diagram for CW::DrawingElement:

Public Member Functions
	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

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 46 of file DrawingElement.hpp.

Constructor & Destructor Documentation

CW::DrawingElement::DrawingElement	(	SUDrawingElementRef	drawing_element,
		bool	attached = `true`
	)

Most common constructor.

Parameters

drawing_element	- SUDrawingElementRef object to assign to the object.
attached	- flag indicating if the entity should be treated as attached to another object

See also: CW::Entity

Definition at line 43 of file DrawingElement.cpp.

CW::DrawingElement::DrawingElement	(	const DrawingElement &	other,
		SUDrawingElementRef	element_ref = `SU_INVALID`
	)

Copy constructor with an optional parameter for the entity reference. SUDrawingElementRef objects cannot be created from this class, so the Ref object must be passed to this constructor from a derived class object.

Parameters

other	- DrawingElement object from which properties will be copied.
element_ref	- SUDrawingElementRef object to assign to the copied object.

Definition at line 48 of file DrawingElement.cpp.

CW::DrawingElement::DrawingElement ( )

Constructor representing a null object.

Definition at line 52 of file DrawingElement.cpp.

Member Function Documentation

BoundingBox3D CW::DrawingElement::bounds ( )

Returns the bounding box of the drawing element.

Definition at line 77 of file DrawingElement.cpp.

bool CW::DrawingElement::copy_properties_from ( const DrawingElement & element )

Copies all DrawingElement properties from the given element to this one.

Parameters

element DrawingElement object from which to get properties

Returns: bool true for success, or false for a failure.

Definition at line 88 of file DrawingElement.cpp.

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

Copy assignment operator

Definition at line 58 of file DrawingElement.cpp.

SUDrawingElementRef CW::DrawingElement::ref ( ) const

Cast to native objects

Definition at line 67 of file DrawingElement.cpp.

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

/home/travis/build/TommyKaneko/Sketchup-API-C-Wrapper/include/SUAPI-CppWrapper/model/DrawingElement.hpp
/home/travis/build/TommyKaneko/Sketchup-API-C-Wrapper/src/SUAPI-CppWrapper/model/DrawingElement.cpp

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation