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

Public Member Functions | Properties

ISkpEdgeUse Interface Reference

An EdgeUse interface. More...

Inheritance diagram for ISkpEdgeUse:
SkpEdgeUse

List of all members.

Public Member Functions

HRESULT _GetStartPoint ([out]double pPoint3d[3])
 Get the start point of this edgeuse.
HRESULT _GetEndPoint ([out]double pPoint3d[3])
 Get the end point of this edgeuse.

Properties

ISkpEdge Edge [get]
 [propget] Returns the Edge referenced by this EdgeUse.
ISkpLoop Loop [get]
 [propget] Returns the Loop partially defined by this EdgeUse.
ISkpFace Face [get]
 [propget] Returns the Face partially defined by this EdgeUse.
ISkpEdgeUses Partners [get]
 [propget] Returns the other EdgeUses that are linked to this one.
BOOL IsReversed [get]
 [propget] Determines whether this EdgeUse is traversed in the same direction as its corresponding Edge.
ISkpEdgeUse Previous [get]
 [propget] Returns the EdgeUse just preceeding this one in the collection of linked EdgeUses.
ISkpEdgeUse Next [get]
 [propget] Returns the EdgeUse just following this one in the collection of linked EdgeUses.
ISkpVertex StartVertex [get]
 [propget] Get the start vertex associated with this edgeuse.
ISkpVertex EndVertex [get]
 [propget] Get the end vertex associated with this edgeuse.
ISkpPoint3d StartPoint [get]
 [propget] Get the start point of this edgeuse.
ISkpPoint3d EndPoint [get]
 [propget] Get the end point of this edgeuse.
ISkpVector3d StartVertexNormal [get]
 [propget] Get the vertex normal at the start of this edgeuse.
ISkpVector3d EndVertexNormal [get]
 [propget] Get the vertex normal at the end of this edgeuse.

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:
ISkpFace
ISkpEdge
ISkpLoop

Member Function Documentation

HRESULT ISkpEdgeUse::_GetEndPoint ( [out] double  pPoint3d[3]  ) 

Get the end point of this edgeuse.

It is assumed that the calling application has allocated space for the return values.

Parameters:
pPoint3d The end point of this edgeuse.
Returns:
S_OK : if successful
E_POINTER : if any of the inputs are NULL
E_FAIL : on internal errors.
HRESULT ISkpEdgeUse::_GetStartPoint ( [out] double  pPoint3d[3]  ) 

Get the start point of this edgeuse.

It is assumed that the calling application has allocated space for the return values.

Parameters:
pPoint3d The start point of this edgeuse.
Returns:
S_OK : if successful
E_POINTER : if any of the inputs are NULL
E_FAIL : on internal errors.

Property Documentation

ISkpEdge ISkpEdgeUse::Edge [get]

[propget] Returns the Edge referenced by this EdgeUse.

Return values:
pVal The EdgeUse's referenced Edge.
Returns:
S_OK : if successful
E_POINTER : if any of the required arguments are NULL
E_FAIL : internal errors
ISkpPoint3d ISkpEdgeUse::EndPoint [get]

[propget] Get the end point of this edgeuse.

Return values:
pVal The end point of this edgeuse.
Returns:
S_OK : if successful
E_POINTER : if any of the inputs are NULL
E_FAIL : on internal errors.
ISkpVertex ISkpEdgeUse::EndVertex [get]

[propget] Get the end vertex associated with this edgeuse.

Return values:
pEndVertex The associated end vertex object.
Returns:
S_OK : if successful
E_POINTER : if any of the inputs are NULL
E_FAIL : on internal errors.
ISkpVector3d ISkpEdgeUse::EndVertexNormal [get]

[propget] Get the vertex normal at the end of this edgeuse.

Return values:
pVal The end vertex normal of this edgeuse.
Returns:
S_OK : if successful
E_POINTER : if any of the inputs are NULL
E_FAIL : on internal errors.
ISkpFace ISkpEdgeUse::Face [get]

[propget] Returns the Face partially defined by this EdgeUse.

Return values:
pVal The Face associated with this EdgeUse.
Returns:
S_OK : if successful
E_POINTER : if any of the required arguments are NULL
E_FAIL : internal errors
BOOL ISkpEdgeUse::IsReversed [get]

[propget] Determines whether this EdgeUse is traversed in the same direction as its corresponding Edge.

See also:
ISkpEdgeUse::Edge
Return values:
pVal TRUE iff the EdgeUse and its Edge are traversed in the same direction.
Returns:
S_OK : if successful
E_POINTER : if any of the required arguments are NULL
E_FAIL : internal errors
ISkpLoop ISkpEdgeUse::Loop [get]

[propget] Returns the Loop partially defined by this EdgeUse.

Return values:
pVal The Loop associated with this EdgeUse.
Returns:
S_OK : if successful
E_POINTER : if any of the required arguments are NULL
E_FAIL : internal errors
ISkpEdgeUse ISkpEdgeUse::Next [get]

[propget] Returns the EdgeUse just following this one in the collection of linked EdgeUses.

Return values:
pVal The following EdgeUse.
Returns:
S_OK : if successful
E_POINTER : if any of the required arguments are NULL
E_FAIL : internal errors
ISkpEdgeUses ISkpEdgeUse::Partners [get]

[propget] Returns the other EdgeUses that are linked to this one.

Return values:
pVal The linked EdgeUses.
Returns:
S_OK : if successful
E_POINTER : if any of the required arguments are NULL
E_FAIL : internal errors
ISkpEdgeUse ISkpEdgeUse::Previous [get]

[propget] Returns the EdgeUse just preceeding this one in the collection of linked EdgeUses.

Return values:
pVal The preceeding EdgeUse.
Returns:
S_OK : if successful
E_POINTER : if any of the required arguments are NULL
E_FAIL : internal errors
ISkpPoint3d ISkpEdgeUse::StartPoint [get]

[propget] Get the start point of this edgeuse.

Return values:
pVal The start point of this edgeuse.
Returns:
S_OK : if successful
E_POINTER : if any of the inputs are NULL
E_FAIL : on internal errors.
ISkpVertex ISkpEdgeUse::StartVertex [get]

[propget] Get the start vertex associated with this edgeuse.

Return values:
pStartVertex The associated start vertex object.
Returns:
S_OK : if successful
E_POINTER : if any of the inputs are NULL
E_FAIL : on internal errors.
ISkpVector3d ISkpEdgeUse::StartVertexNormal [get]

[propget] Get the vertex normal at the start of this edgeuse.

Return values:
pVal The start vertex normal of this edgeuse.
Returns:
S_OK : if successful
E_POINTER : if any of the inputs are NULL
E_FAIL : on internal errors.

©2010 Google - Google Home - About Google