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

Public Member Functions

atlast::sketchup::ISketchUpEdge Interface Reference

An Edge object. More...

#include <iedge.h>

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

List of all members.

Public Member Functions

virtual void SetSmooth (bool isSmooth)=0
 Sets the "smooth" property of an Edge.
virtual bool IsSmooth () const =0
 Gets the smooth property of an Edge. If this edge is not valid false is returned.
virtual void SetSoft (bool isSoft)=0
 Sets the "soft" property of an Edge.
virtual bool IsSoft () const =0
 Gets the soft property of an Edge.
virtual ISketchUpVertexPtr GetStartVertex () const =0
 Retrieves the start vertex of this edge.
virtual ISketchUpVertexPtr GetEndVertex () const =0
 Retrieves the end vertex of this edge.
virtual ISketchUpFaceVectorPtr GetFaces () const =0
 Get the faces that use this edge as a boundary.
virtual ISketchUpVertexVectorPtr GetVertices () const =0
 Get the vertices used by this edge.

Detailed Description

An Edge object.

Every 2-dimensional object in SketchUp is represented by one or more connected Edge.


Member Function Documentation

virtual ISketchUpVertexPtr atlast::sketchup::ISketchUpEdge::GetEndVertex (  )  const [pure virtual]

Retrieves the end vertex of this edge.

Returns a NULL pointer if this is not a valid Edge.

Returns:
The end vertex of this Edge.
virtual ISketchUpFaceVectorPtr atlast::sketchup::ISketchUpEdge::GetFaces (  )  const [pure virtual]

Get the faces that use this edge as a boundary.

If no such faces exist, the vector will be empty.

If the edge is not valid, the vector will be empty.

Returns:
A vector of all the faces using this Edge.
virtual ISketchUpVertexPtr atlast::sketchup::ISketchUpEdge::GetStartVertex (  )  const [pure virtual]

Retrieves the start vertex of this edge.

Returns a NULL pointer if this is not a valid Edge.

Returns:
The start vertex of this Edge.
virtual ISketchUpVertexVectorPtr atlast::sketchup::ISketchUpEdge::GetVertices (  )  const [pure virtual]

Get the vertices used by this edge.

If the edge is not valid, the vector will be empty.

Returns:
A vector of start, then end, vertices of this edge.
virtual bool atlast::sketchup::ISketchUpEdge::IsSmooth (  )  const [pure virtual]

Gets the smooth property of an Edge. If this edge is not valid false is returned.

Returns:
true iff this Edge is smoothed.
virtual bool atlast::sketchup::ISketchUpEdge::IsSoft (  )  const [pure virtual]

Gets the soft property of an Edge.

If this edge is not valid false is returned.

Returns:
true iff this Edge is softened.
virtual void atlast::sketchup::ISketchUpEdge::SetSmooth ( bool  isSmooth  )  [pure virtual]

Sets the "smooth" property of an Edge.

Parameters:
isSmooth Set to true to smooth the edge.
virtual void atlast::sketchup::ISketchUpEdge::SetSoft ( bool  isSoft  )  [pure virtual]

Sets the "soft" property of an Edge.

Parameters:
isSoft Set to true to soften the edge.

©2010 Google - Google Home - About Google