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

References a loop object, which can be either the outer loop or an inner loop (hole) of a face. More...

#include <SketchUpAPI/model/loop.h>

Inherits SUEntityRef.

Related Functions

(Note that these are not member functions.)

SUEntityRef SULoopToEntity (SULoopRef loop)
 Converts from an SULoopRef to an SUEntityRef. This is essentially an upcast operation. More...
 
SULoopRef SULoopFromEntity (SUEntityRef entity)
 Converts from an SUEntityRef to an SULoopRef. This is essentially a downcast operation so the given SUEntityRef must be convertible to an SULoopRef. More...
 
enum SUResult SULoopGetNumVertices (SULoopRef loop, size_t *count)
 Retrieves the number of vertices of a face loop. More...
 
enum SUResult SULoopGetVertices (SULoopRef loop, size_t len, SUVertexRef vertices[], size_t *count)
 Retrieves the vertices of a face loop object. More...
 
enum SUResult SULoopGetEdges (SULoopRef loop, size_t len, SUEdgeRef edges[], size_t *count)
 Retrieves the edges of a loop object. More...
 
enum SUResult SULoopGetWinding (SULoopRef loop, const struct SUVector3D *vector3d, enum SULoopWinding *orientation)
 Retrieves the winding of a loop object with respect to a vector. More...
 
enum SUResult SULoopIsEdgeReversed (SULoopRef loop, SUEdgeRef edge, bool *reversed)
 Retrieves a flag indicating the orientation of the given edge relative to a loop object. More...
 
enum SUResult SULoopGetFace (SULoopRef loop, SUFaceRef *face)
 Retrieves the parent face of a loop object. More...
 
enum SUResult SULoopIsConvex (SULoopRef loop, bool *convex)
 Retrieves a flag indicating the whether the loop is convex. More...
 
enum SUResult SULoopIsOuterLoop (SULoopRef loop, bool *outer_loop)
 Retrieves a flag indicating the whether the loop is the outer loop on its associated face. More...
 
enum SUResult SULoopGetEdgeUses (SULoopRef loop, size_t len, SUEdgeUseRef edge_uses[], size_t *count)
 Retrieves the edge use objects of a loop. More...
 

Detailed Description

References a loop object, which can be either the outer loop or an inner loop (hole) of a face.

Friends And Related Function Documentation

SULoopRef SULoopFromEntity ( SUEntityRef  entity)
related

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

Parameters
[in]entityThe given entity reference.
Returns
  • The converted SULoopRef if the downcast operation succeeds
  • If not, the returned reference will be invalid
enum SUResult SULoopGetEdges ( SULoopRef  loop,
size_t  len,
SUEdgeRef  edges[],
size_t *  count 
)
related

Retrieves the edges of a loop object.

Parameters
[in]loopThe loop object.
[in]lenThe number of edges to retrieve.
[out]edgesThe edges retrieved.
[out]countThe number of edges retrieved.
Returns
enum SUResult SULoopGetEdgeUses ( SULoopRef  loop,
size_t  len,
SUEdgeUseRef  edge_uses[],
size_t *  count 
)
related

Retrieves the edge use objects of a loop.

Parameters
[in]loopThe loop object.
[in]lenThe number of edge uses to retrieve.
[out]edge_usesThe edge uses retrieved.
[out]countThe number of edge uses retrieved.
Returns
enum SUResult SULoopGetFace ( SULoopRef  loop,
SUFaceRef face 
)
related

Retrieves the parent face of a loop object.

Parameters
[in]loopThe loop object.
[out]faceThe face retrieved.
Returns
enum SUResult SULoopGetNumVertices ( SULoopRef  loop,
size_t *  count 
)
related

Retrieves the number of vertices of a face loop.

Parameters
[in]loopThe loop object.
[out]countThe number of vertices.
Returns
enum SUResult SULoopGetVertices ( SULoopRef  loop,
size_t  len,
SUVertexRef  vertices[],
size_t *  count 
)
related

Retrieves the vertices of a face loop object.

Parameters
[in]loopThe loop object.
[in]lenThe number of vertices to retrieve.
[out]verticesThe vertices retrieved.
[out]countThe number of vertices retrieved.
Returns
enum SUResult SULoopGetWinding ( SULoopRef  loop,
const struct SUVector3D vector3d,
enum SULoopWinding orientation 
)
related

Retrieves the winding of a loop object with respect to a vector.

Parameters
[in]loopThe loop object.
[in]vector3dThe 3D vector.
[out]orientationThe orientation retrieved.
Returns
enum SUResult SULoopIsConvex ( SULoopRef  loop,
bool *  convex 
)
related

Retrieves a flag indicating the whether the loop is convex.

Parameters
[in]loopThe loop object.
[out]convexThe flag retrieved. A return value of true indicates the loop is convex.
Returns
enum SUResult SULoopIsEdgeReversed ( SULoopRef  loop,
SUEdgeRef  edge,
bool *  reversed 
)
related

Retrieves a flag indicating the orientation of the given edge relative to a loop object.

Parameters
[in]loopThe loop object.
[in]edgeThe edge object.
[out]reversedThe flag retrieved. A return value of true indicates that the given edge is oriented opposite of the loop object.
Returns
enum SUResult SULoopIsOuterLoop ( SULoopRef  loop,
bool *  outer_loop 
)
related

Retrieves a flag indicating the whether the loop is the outer loop on its associated face.

Parameters
[in]loopThe loop object.
[out]outer_loopThe flag retrieved. A return value of true indicates the loop is the outer loop.
Returns
SUEntityRef SULoopToEntity ( SULoopRef  loop)
related

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

Parameters
[in]loopThe given loop reference.
Returns
  • The converted SUEntityRef if loop is a valid object
  • If not, the returned reference will be invalid

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