SketchUp C API
 All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
Related Functions
SUEdgeUseRef Struct Reference

SUEdgeUseRef objects are used to retrieve the topology of the edges of a polygon. The geometry of the polygon being represented by SULoopRef that is already associated with a face object. The typical use of EdgeUse object is to retrieve them from a face object's loop, and then read the topology values from them. More...

#include <SketchUpAPI/model/edge_use.h>

Inherits SUEntityRef.

Related Functions

(Note that these are not member functions.)

SUEntityRef SUEdgeUseToEntity (SUEdgeUseRef edgeuse)
 Converts from an SUEdgeUseRef to an SUEntityRef. This is essentially an upcast operation. More...
 
SUEdgeUseRef SUEdgeUseFromEntity (SUEntityRef entity)
 Converts from an SUEntityRef to an SUEdgeUseRef. This is essentially a downcast operation so the given SUEntityRef must be convertible to an SUEdgeUseRef. More...
 
enum SUResult SUEdgeUseGetEdge (SUEdgeUseRef edgeuse, SUEdgeRef *edge)
 Retrieves the edge object the EdgeUse object belongs to. More...
 
enum SUResult SUEdgeUseGetLoop (SUEdgeUseRef edgeuse, SULoopRef *loop)
 Retrieves the loop object the EdgeUse object is associated with. More...
 
enum SUResult SUEdgeUseGetFace (SUEdgeUseRef edgeuse, SUFaceRef *face)
 Retrieves the face object the EdgeUse object is associated with. More...
 
enum SUResult SUEdgeUseGetNumPartners (SUEdgeUseRef edgeuse, size_t *count)
 Retrieves the number of EdgeUse objects that are linked to the EdgeUse object. More...
 
enum SUResult SUEdgeUseGetPartners (SUEdgeUseRef edgeuse, size_t len, SUEdgeUseRef partners[], size_t *count)
 Retrieves the EdgeUse objects that are linked to the EdgeUse object. More...
 
enum SUResult SUEdgeUseIsReversed (SUEdgeUseRef edgeuse, bool *reversed)
 Retrieves a flag indicating whether this EdgeUse is traversed in the opposite direction as its corresponding edge. More...
 
enum SUResult SUEdgeUseGetPrevious (SUEdgeUseRef edgeuse, SUEdgeUseRef *prev_edgeuse)
 Retrieves the EdgeUse object just preceding an EdgeUse object in the collection of linked EdgeUses. More...
 
enum SUResult SUEdgeUseGetNext (SUEdgeUseRef edgeuse, SUEdgeUseRef *next_edgeuse)
 Retrieves the EdgeUse object just following an EdgeUse object in the collection of linked EdgeUses. More...
 
enum SUResult SUEdgeUseGetStartVertex (SUEdgeUseRef edgeuse, SUVertexRef *vertex)
 Retrieves the start vertex of an EdgeUse object. The start vertex of the EdgeUse object may not be the same as the start vertex of the corresponding edge of the EdgeUse object. An EdgeUse object is part of a face loop whose direction may be the reverse of the direction of the edge. More...
 
enum SUResult SUEdgeUseGetEndVertex (SUEdgeUseRef edgeuse, SUVertexRef *vertex)
 Retrieves the end vertex of an EdgeUse object. More...
 
enum SUResult SUEdgeUseGetStartVertexNormal (SUEdgeUseRef edgeuse, struct SUVector3D *normal)
 Retrieves the normal vector at the start vertex of an EdgeUse object. More...
 
enum SUResult SUEdgeUseGetEndVertexNormal (SUEdgeUseRef edgeuse, struct SUVector3D *normal)
 Retrieves the normal vector at the end vertex of an EdgeUse object. More...
 

Detailed Description

SUEdgeUseRef objects are used to retrieve the topology of the edges of a polygon. The geometry of the polygon being represented by SULoopRef that is already associated with a face object. The typical use of EdgeUse object is to retrieve them from a face object's loop, and then read the topology values from them.

Friends And Related Function Documentation

SUEdgeUseRef SUEdgeUseFromEntity ( SUEntityRef  entity)
related

Converts from an SUEntityRef to an SUEdgeUseRef. This is essentially a downcast operation so the given SUEntityRef must be convertible to an SUEdgeUseRef.

Parameters
[in]entityThe given entity reference.
Returns
  • The converted SUEdgeUseRef if the downcast operation succeeds.
  • If not, the returned reference will be invalid.
enum SUResult SUEdgeUseGetEdge ( SUEdgeUseRef  edgeuse,
SUEdgeRef edge 
)
related

Retrieves the edge object the EdgeUse object belongs to.

Parameters
[in]edgeuseThe EdgeUse object.
[out]edgeThe edge object retrieved.
Returns
enum SUResult SUEdgeUseGetEndVertex ( SUEdgeUseRef  edgeuse,
SUVertexRef vertex 
)
related

Retrieves the end vertex of an EdgeUse object.

The end vertex of the EdgeUse object may not be the same as the end vertex of the corresponding edge of the EdgeUse object. An EdgeUse object is part of a face loop whose direction may be the reverse of the direction of the edge.

Parameters
[in]edgeuseThe EdgeUse object.
[out]vertexThe vertex object retrieved.
Returns
enum SUResult SUEdgeUseGetEndVertexNormal ( SUEdgeUseRef  edgeuse,
struct SUVector3D normal 
)
related

Retrieves the normal vector at the end vertex of an EdgeUse object.

Parameters
[in]edgeuseThe EdgeUse object.
[out]normalThe normal vector retrieved.
Returns
enum SUResult SUEdgeUseGetFace ( SUEdgeUseRef  edgeuse,
SUFaceRef face 
)
related

Retrieves the face object the EdgeUse object is associated with.

Parameters
[in]edgeuseThe EdgeUse object.
[out]faceThe face object retrieved.
Returns
enum SUResult SUEdgeUseGetLoop ( SUEdgeUseRef  edgeuse,
SULoopRef loop 
)
related

Retrieves the loop object the EdgeUse object is associated with.

Parameters
[in]edgeuseThe EdgeUse object.
[out]loopThe loop object retrieved.
Returns
enum SUResult SUEdgeUseGetNext ( SUEdgeUseRef  edgeuse,
SUEdgeUseRef next_edgeuse 
)
related

Retrieves the EdgeUse object just following an EdgeUse object in the collection of linked EdgeUses.

Parameters
[in]edgeuseThe EdgeUse object.
[out]next_edgeuseThe EdgeUse retrieved.
Returns
enum SUResult SUEdgeUseGetNumPartners ( SUEdgeUseRef  edgeuse,
size_t *  count 
)
related

Retrieves the number of EdgeUse objects that are linked to the EdgeUse object.

Parameters
[in]edgeuseThe EdgeUse object.
[out]countThe number of partners.
Returns
enum SUResult SUEdgeUseGetPartners ( SUEdgeUseRef  edgeuse,
size_t  len,
SUEdgeUseRef  partners[],
size_t *  count 
)
related

Retrieves the EdgeUse objects that are linked to the EdgeUse object.

Parameters
[in]edgeuseThe EdgeUse object.
[in]lenThe number of partners to retrieve.
[out]partnersThe partners retrieved.
[out]countThe number of partners retrieved.
Returns
enum SUResult SUEdgeUseGetPrevious ( SUEdgeUseRef  edgeuse,
SUEdgeUseRef prev_edgeuse 
)
related

Retrieves the EdgeUse object just preceding an EdgeUse object in the collection of linked EdgeUses.

Parameters
[in]edgeuseThe EdgeUse object.
[out]prev_edgeuseThe EdgeUse retrieved.
Returns
enum SUResult SUEdgeUseGetStartVertex ( SUEdgeUseRef  edgeuse,
SUVertexRef vertex 
)
related

Retrieves the start vertex of an EdgeUse object. The start vertex of the EdgeUse object may not be the same as the start vertex of the corresponding edge of the EdgeUse object. An EdgeUse object is part of a face loop whose direction may be the reverse of the direction of the edge.

Parameters
[in]edgeuseThe EdgeUse object.
[out]vertexThe vertex object retrieved.
Returns
enum SUResult SUEdgeUseGetStartVertexNormal ( SUEdgeUseRef  edgeuse,
struct SUVector3D normal 
)
related

Retrieves the normal vector at the start vertex of an EdgeUse object.

Parameters
[in]edgeuseThe EdgeUse object.
[out]normalThe normal vector retrieved.
Returns
enum SUResult SUEdgeUseIsReversed ( SUEdgeUseRef  edgeuse,
bool *  reversed 
)
related

Retrieves a flag indicating whether this EdgeUse is traversed in the opposite direction as its corresponding edge.

Parameters
[in]edgeuseThe EdgeUse object.
[out]reversedThe retrieved flag.
Returns
SUEntityRef SUEdgeUseToEntity ( SUEdgeUseRef  edgeuse)
related

Converts from an SUEdgeUseRef to an SUEntityRef. This is essentially an upcast operation.

Parameters
[in]edgeuseThe given edge use reference.
Returns
  • The converted SUEntityRef if edgeuse is a valid edge use.
  • If not, the returned reference will be invalid.

The documentation for this struct was generated from the following files: