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

Public Member Functions

atlast::sketchup::ISketchUpEdgeUse Interface Reference

An EdgeUse interface. More...

#include <iedgeuse.h>

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

List of all members.

Public Member Functions

virtual ISketchUpEdgePtr GetEdge () const =0
 Retrieves the corresponding Edge.
virtual ISketchUpFacePtr GetFace () const =0
 Retrieves the face which is partially defined by this edge use.
virtual ISketchUpLoopPtr GetLoop () const =0
 Gets the loop in which this EdgeUse is a participant.
virtual bool IsReversed () const =0
 Determines whether this EdgeUse is reversed relative to the underlying edge.
virtual ISketchUpEdgeUsePtr GetNext () const =0
 Gets the next EdgeUse in this loop.
virtual ISketchUpEdgeUsePtr GetPrevious () const =0
 Gets the previous EdgeUse in this loop.

Detailed Description

An EdgeUse interface.

An edge use is used by loops to identify which edges bound the loop. Since the loop requires counter-clockwise traversal about its normal, some of the edges that make up the loop may be traversed in reverse order (as compared to their natural direction). The EdgeUse captures this information.

EdgeUses are linked in a circular list, which can be traversed via the Previous and Next methods.

In addition, the edge uses maintain a link to the other edge uses used by the same face.

See also:
ISketchUpFace
ISketchUpEdge
ISketchUpLoop

Member Function Documentation

virtual ISketchUpEdgePtr atlast::sketchup::ISketchUpEdgeUse::GetEdge (  )  const [pure virtual]

Retrieves the corresponding Edge.

As an EdgeUse is essentially a reference to an Edge, this method retrieves the underlying edge object.

If this object is not valid, NULL is returned.

Returns:
The underlying Edge.
virtual ISketchUpFacePtr atlast::sketchup::ISketchUpEdgeUse::GetFace (  )  const [pure virtual]

Retrieves the face which is partially defined by this edge use.

If this object is not valid, NULL is returned.

Returns:
The face partially bounded by this EdgeUse.
virtual ISketchUpLoopPtr atlast::sketchup::ISketchUpEdgeUse::GetLoop (  )  const [pure virtual]

Gets the loop in which this EdgeUse is a participant.

If this object is not valid, NULL is returned.

Returns:
The loop containing this EdgeUse.
virtual ISketchUpEdgeUsePtr atlast::sketchup::ISketchUpEdgeUse::GetNext (  )  const [pure virtual]

Gets the next EdgeUse in this loop.

If this object is not valid, NULL is returned.

Returns:
The next edge use in the loop.
virtual ISketchUpEdgeUsePtr atlast::sketchup::ISketchUpEdgeUse::GetPrevious (  )  const [pure virtual]

Gets the previous EdgeUse in this loop.

If this object is not valid, NULL is returned.

Returns:
The previous edge use in the loop.
virtual bool atlast::sketchup::ISketchUpEdgeUse::IsReversed (  )  const [pure virtual]

Determines whether this EdgeUse is reversed relative to the underlying edge.

If this object is not valid, false is returned.

Returns:
true iff this EdgeUse is reversed relative to its underlying Edge.

©2010 Google - Google Home - About Google