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

Public Member Functions

atlast::sketchup::ISketchUpController Interface Reference

A controller object for actions that involve more than the basic properties of a single object. More...

#include <icontroller.h>

Inheritance diagram for atlast::sketchup::ISketchUpController:
atlast::sketchup::ISketchUpEntity atlast::sketchup::ISketchUpObject

List of all members.

Public Member Functions

virtual bool IsValid () const =0
 every object knows whether it is valid.
virtual bool Transform (const ISketchUpGeometricElementVector *eSet, const atlast::geometry::CTransformation &trans)=0
 Transforms all the objects in the given set.
virtual bool Transform (ISketchUpGeometricElement *pElement, const atlast::geometry::CTransformation &trans)=0
 Transforms the given element along with connected objects. For example, transforming a face that has a component attached to it will result in the transforming the attached component.
virtual bool Transform (ISketchUpEntityContainer *pContainer, const atlast::geometry::CTransformation &trans)=0
 Transforms the entities in the given container.
virtual void Erase (const ISketchUpDrawingElementVector *eSet)=0
 Erase the elements in the given set.
virtual void Erase (ISketchUpDrawingElement **objs, int nObjs)=0
 Erase the elements in the given array.
virtual void Erase (ISketchUpDrawingElement *pElement)=0
 Erase the given element. Any dependent objects will also be erased. For example, if an edge is erased, the faces attached to the edge will also be erased.
virtual void Erase (ISketchUpSelectionSet *pSS)=0
 Erase the elements in the given selection set. Any dependent objects will also be erased. For example, if an edge is erased, the faces attached to the edge will also be erased.
virtual
ISketchUpDrawingElementVectorPtr 
GetAllConnected (ISketchUpDrawingElement *pElement)=0
 Retrieves all the elements connected to the given element.
virtual void Extrude (ISketchUpFace *pFace, double distance)=0
 Extrude the given face in the direction of its normal the amount given in the distance parameter.
virtual void MergeCoplanarFaces (ISketchUpEntityContainer *pContainer, bool bRecurse)=0
 Merge all the coplanar faces in the given container.
virtual void FixErrors (ISketchUpEntityContainer *pContainer)=0
 Fixes any errors found in the given container.
virtual void FixErrors (ISketchUpModel *pModel)=0
 Fixes any errors found in the given model.

Detailed Description

A controller object for actions that involve more than the basic properties of a single object.


Member Function Documentation

virtual void atlast::sketchup::ISketchUpController::Erase ( const ISketchUpDrawingElementVector *  eSet  )  [pure virtual]

Erase the elements in the given set.

Any dependent objects will also be erased. For example, if an edge is erased, the faces attached to the edge will also be erased.

Parameters:
eSet The set of objects to erase.
virtual void atlast::sketchup::ISketchUpController::Erase ( ISketchUpSelectionSet *  pSS  )  [pure virtual]

Erase the elements in the given selection set. Any dependent objects will also be erased. For example, if an edge is erased, the faces attached to the edge will also be erased.

Parameters:
pSS The selection set of objects to erase.
virtual void atlast::sketchup::ISketchUpController::Erase ( ISketchUpDrawingElement **  objs,
int  nObjs 
) [pure virtual]

Erase the elements in the given array.

Any dependent objects will also be erased. For example, if an edge is erased, the faces attached to the edge will also be erased.

Parameters:
objs The set of objects to erase.
nObjs The number of objects in the array
virtual void atlast::sketchup::ISketchUpController::Erase ( ISketchUpDrawingElement pElement  )  [pure virtual]

Erase the given element. Any dependent objects will also be erased. For example, if an edge is erased, the faces attached to the edge will also be erased.

Parameters:
pElement The object to erase.
virtual void atlast::sketchup::ISketchUpController::Extrude ( ISketchUpFace pFace,
double  distance 
) [pure virtual]

Extrude the given face in the direction of its normal the amount given in the distance parameter.

Parameters:
pFace The face to extrude.
distance The amount to extrude. Can be positive or negative.
virtual void atlast::sketchup::ISketchUpController::FixErrors ( ISketchUpModel *  pModel  )  [pure virtual]

Fixes any errors found in the given model.

Parameters:
pModel The model.
virtual void atlast::sketchup::ISketchUpController::FixErrors ( ISketchUpEntityContainer pContainer  )  [pure virtual]

Fixes any errors found in the given container.

Parameters:
pContainer The container.
virtual ISketchUpDrawingElementVectorPtr atlast::sketchup::ISketchUpController::GetAllConnected ( ISketchUpDrawingElement pElement  )  [pure virtual]

Retrieves all the elements connected to the given element.

While the return value is a vector, it obeys set semantics in that each element is represented exactly once.

Parameters:
pElement The element to seed the traversal.
Returns:
The set of all connected elements. This will include Faces and Edges, not Vertices.
virtual bool atlast::sketchup::ISketchUpController::IsValid (  )  const [pure virtual]

every object knows whether it is valid.

Returns:
true iff this is a valid object.

Implements atlast::sketchup::ISketchUpObject.

virtual void atlast::sketchup::ISketchUpController::MergeCoplanarFaces ( ISketchUpEntityContainer pContainer,
bool  bRecurse 
) [pure virtual]

Merge all the coplanar faces in the given container.

Parameters:
pContainer The container.
bRecurse If true, will recurse through all used components.
virtual bool atlast::sketchup::ISketchUpController::Transform ( ISketchUpGeometricElement pElement,
const atlast::geometry::CTransformation &  trans 
) [pure virtual]

Transforms the given element along with connected objects. For example, transforming a face that has a component attached to it will result in the transforming the attached component.

Parameters:
pElement The object to transform.
trans The transformation to use.
Returns:
true iff the transform worked.
virtual bool atlast::sketchup::ISketchUpController::Transform ( const ISketchUpGeometricElementVector *  eSet,
const atlast::geometry::CTransformation &  trans 
) [pure virtual]

Transforms all the objects in the given set.

Parameters:
eSet A collection containing DrawingElements and Vertices to be transformed. It is assumed this is a "set" in the sense that entities are not duplicated.
trans The transformation to use.
Returns:
true iff the transform worked.
virtual bool atlast::sketchup::ISketchUpController::Transform ( ISketchUpEntityContainer pContainer,
const atlast::geometry::CTransformation &  trans 
) [pure virtual]

Transforms the entities in the given container.

Parameters:
pContainer The container to transform.
trans The transformation to use.
Returns:
true iff the transform worked.

©2010 Google - Google Home - About Google