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

Public Member Functions

 Axes ()
 
 Axes (SUAxesRef axes, bool attached=true)
 
 Axes (Point3D origin, Vector3D x_axis, Vector3D y_axis, Vector3D z_axis)
 
 Axes (const Axes &other)
 
 ~Axes ()
 
SUAxesRef ref () const
 
Axesoperator= (const Axes &other)
 
bool operator! () const
 
Vector3D x_axis () const
 
Vector3D y_axis () const
 
Vector3D z_axis () const
 
Point3D origin () const
 
Transformation transformation () const
 
- 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 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 Axes.hpp.

Constructor & Destructor Documentation

CW::Axes::Axes ( )

Constructor for null object.

Definition at line 74 of file Axes.cpp.

CW::Axes::Axes ( SUAxesRef  axes,
bool  attached = true 
)

Standard constructor from existing SUAxesRef object.

Parameters
axes- existing SUAxesRef object to wrap.
attached- true if the SUAxesRef has been attached to the model. Required for object release purposes.

Definition at line 79 of file Axes.cpp.

CW::Axes::Axes ( Point3D  origin,
Vector3D  x_axis,
Vector3D  y_axis,
Vector3D  z_axis 
)

Constructs Axes object from the given origin, x, y and z axes. The vectors passed to the constructor must be orthogonal, otherwise, a null object will be created.

Parameters
origin- origin of the Axes.
x_axes- vector representing the x axis.
y_axes- vector representing the y axis.
z_axes- vector representing the z axis.

Definition at line 84 of file Axes.cpp.

CW::Axes::Axes ( const Axes other)

Copy constructor

Definition at line 89 of file Axes.cpp.

CW::Axes::~Axes ( )

Destructor

Definition at line 94 of file Axes.cpp.

Member Function Documentation

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

Operator overload signifies if this a valid object.

Definition at line 122 of file Axes.cpp.

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

Copy assignment operator override

Copy assignment operator

Definition at line 109 of file Axes.cpp.

Point3D CW::Axes::origin ( ) const

Return the origin of the axes as a Point3D object.

Definition at line 167 of file Axes.cpp.

SUAxesRef CW::Axes::ref ( ) const

Returns the SU native reference

Definition at line 132 of file Axes.cpp.

Transformation CW::Axes::transformation ( ) const

Return the transformation object of the axes.

Definition at line 178 of file Axes.cpp.

Vector3D CW::Axes::x_axis ( ) const

Return the vectors representing the axes.

Definition at line 136 of file Axes.cpp.


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