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

A vertex type that has a position and is associated with other geometry like edges, faces, and loops. More...

#include <SketchUpAPI/model/vertex.h>

Inherits SUEntityRef.

Related Functions

(Note that these are not member functions.)

SUEntityRef SUVertexToEntity (SUVertexRef vertex)
 Converts from an SUVertexRef to an SUEntityRef. This is essentially an upcast operation. More...
 
SUVertexRef SUVertexFromEntity (SUEntityRef entity)
 Converts from an SUEntityRef to an SUVertexRef. This is essentially a downcast operation so the given SUEntityRef must be convertible to an SUVertexRef. More...
 
enum SUResult SUVertexGetPosition (SUVertexRef vertex, struct SUPoint3D *position)
 Retrieves the position of a vertex object. More...
 
enum SUResult SUVertexSetPosition (SUVertexRef vertex, const struct SUPoint3D *position)
 Sets the position of a vertex object. More...
 
enum SUResult SUVertexGetNumEdges (SUVertexRef vertex, size_t *count)
 Retrieves the number of edges that the vertex is associated with. More...
 
enum SUResult SUVertexGetEdges (SUVertexRef vertex, size_t len, SUEdgeRef edges[], size_t *count)
 Retrieves the edge objects associated with a vertex object. More...
 
enum SUResult SUVertexGetNumFaces (SUVertexRef vertex, size_t *count)
 Retrieves the number of faces that the vertex is associated with. More...
 
enum SUResult SUVertexGetFaces (SUVertexRef vertex, size_t len, SUFaceRef faces[], size_t *count)
 Retrieves the face objects associated with a vertex object. More...
 
enum SUResult SUVertexGetNumLoops (SUVertexRef vertex, size_t *count)
 Retrieves the number of loops that the vertex is associated with. More...
 
enum SUResult SUVertexGetLoops (SUVertexRef vertex, size_t len, SULoopRef loops[], size_t *count)
 Retrieves the loop objects associated with a vertex object. More...
 

Detailed Description

A vertex type that has a position and is associated with other geometry like edges, faces, and loops.

Friends And Related Function Documentation

SUVertexRef SUVertexFromEntity ( SUEntityRef  entity)
related

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

Parameters
[in]entityThe entity object.
Returns
  • The converted SUVertexRef if the downcast operation succeeds
  • If the downcast operation fails, the returned reference will be invalid
enum SUResult SUVertexGetEdges ( SUVertexRef  vertex,
size_t  len,
SUEdgeRef  edges[],
size_t *  count 
)
related

Retrieves the edge objects associated with a vertex object.

Parameters
[in]vertexThe vertex object.
[in]lenThe number of edges to retrieve.
[out]edgesThe edges retrieved.
[out]countThe number of edges retrieved.
Returns
enum SUResult SUVertexGetFaces ( SUVertexRef  vertex,
size_t  len,
SUFaceRef  faces[],
size_t *  count 
)
related

Retrieves the face objects associated with a vertex object.

Parameters
[in]vertexThe vertex object.
[in]lenThe number of faces to retrieve.
[out]facesThe faces retrieved.
[out]countThe number of faces retrieved.
Returns
enum SUResult SUVertexGetLoops ( SUVertexRef  vertex,
size_t  len,
SULoopRef  loops[],
size_t *  count 
)
related

Retrieves the loop objects associated with a vertex object.

Parameters
[in]vertexThe vertex object.
[in]lenThe number of loops to retrieve.
[out]loopsThe loops retrieved.
[out]countThe number of loops retrieved.
Returns
enum SUResult SUVertexGetNumEdges ( SUVertexRef  vertex,
size_t *  count 
)
related

Retrieves the number of edges that the vertex is associated with.

Parameters
[in]vertexThe vertex object.
[out]countThe number of edges.
Returns
enum SUResult SUVertexGetNumFaces ( SUVertexRef  vertex,
size_t *  count 
)
related

Retrieves the number of faces that the vertex is associated with.

Parameters
[in]vertexThe vertex object.
[out]countThe number of faces.
Returns
enum SUResult SUVertexGetNumLoops ( SUVertexRef  vertex,
size_t *  count 
)
related

Retrieves the number of loops that the vertex is associated with.

Parameters
[in]vertexThe vertex object.
[out]countThe number of loops.
Returns
enum SUResult SUVertexGetPosition ( SUVertexRef  vertex,
struct SUPoint3D position 
)
related

Retrieves the position of a vertex object.

Parameters
[in]vertexThe vertex object.
[out]positionThe vertex position.
Returns
enum SUResult SUVertexSetPosition ( SUVertexRef  vertex,
const struct SUPoint3D position 
)
related

Sets the position of a vertex object.

Parameters
[in]vertexThe vertex object.
[in]positionThe value used to set the vertex position.
Returns
SUEntityRef SUVertexToEntity ( SUVertexRef  vertex)
related

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

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

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