Go to Google Code Home
Google SketchUp SkpWriter C++ API Documentation (Labs)

Public Member Functions

atlast::sketchup::ISketchUpComponentInstance Class Reference

A Component Instance class. More...

#include <icomponentinstance.h>

Inheritance diagram for atlast::sketchup::ISketchUpComponentInstance:
atlast::sketchup::ISketchUpDrawingElement atlast::sketchup::ISketchUpGeometricElement atlast::sketchup::ISketchUpEntity atlast::sketchup::ISketchUpObject

List of all members.

Public Member Functions

virtual ISketchUpEntityVectorPtr Explode ()=0
 Explodes this Component Instance into its constituent pieces.
virtual
ISketchUpComponentDefinitionPtr 
GetComponentDefinition () const =0
 Retrieves this instance's defintion.
virtual
atlast::geometry::CTransformation 
GetTransformation () const =0
 Retrieves the transformation associated with this instance.
virtual void SetTransform (const atlast::geometry::CTransformation &trans)=0
 Sets the transform of the component instance relative its definition.

Detailed Description

A Component Instance class.


Member Function Documentation

virtual ISketchUpEntityVectorPtr atlast::sketchup::ISketchUpComponentInstance::Explode (  )  [pure virtual]

Explodes this Component Instance into its constituent pieces.

Returns:
A vector of the entities that made up the component.
virtual ISketchUpComponentDefinitionPtr atlast::sketchup::ISketchUpComponentInstance::GetComponentDefinition (  )  const [pure virtual]

Retrieves this instance's defintion.

Returns:
The Component Definition of which this is an instance.
virtual atlast::geometry::CTransformation atlast::sketchup::ISketchUpComponentInstance::GetTransformation (  )  const [pure virtual]

Retrieves the transformation associated with this instance.

The actual geometry associated with this instance is obtained via the definition (see GetComponentDefinition()) and this transform.

To transform this instance, use the ISketchUpController::Transform() method.

Returns:
The transformation that takes the definition's geometry to this instance's geometry.
virtual void atlast::sketchup::ISketchUpComponentInstance::SetTransform ( const atlast::geometry::CTransformation &  trans  )  [pure virtual]

Sets the transform of the component instance relative its definition.

This method should be contrasted with ISketchUpController::Transform(), where the component instance would be transformed from its current location by the given transformation. In this case, its current location is overwritten, and its location - relative to its definition - is set explicitly.

This method is particularly useful when creating new component instances, such as in the case of writing an Importer.

Parameters:
trans The transform from the definition to the desired location of the instance.

©2010 Google - Google Home - About Google