class Sketchup::Vertex

A Vertex. A Vertex represents the end of an Edge or a point inside a Face.

@version SketchUp 6.0

Public Instance Methods

common_edge(vertex2) click to toggle source

The common_edge method is used to find a common edge that is defined by this vertex and another vertex

@example

edge = entities[0]
# returns array of vertices that make up the line
verticies = edge.vertices
vertex1 = verticies[0]
vertex2 = verticies[1]
edge = vertex1.common_edge vertex2
if (edge)
  UI.messagebox edge
else
  UI.messagebox "Failure"
end

@param [Sketchup::Vertex] vertex2

A Vertex object.

@return [Sketchup::Edge, nil] an Edge object common to both vertices if

successful. Returns nil if there is no edge between the
two vertices.

@version SketchUp 6.0

# File lib/sketchup-api-stubs/stubs/Sketchup/Vertex.rb, line 35
def common_edge(vertex2)
end
curve_interior?() click to toggle source

The {#curve_interior?} method is used to determine if this vertex is on the interior of a Curve.

@example

edge = entities[0]
# returns array of vertices that make up the line
verticies = edge.vertices
vertex1 = verticies[0]
status = vertex1.curve_interior?
if (status)
  UI.messagebox status
else
  #returns nil if vertex is not on interior of a Curve
  UI.messagebox "Failure"
end

@note This method doesn't actually return a boolean as the question mark

post-fix would normally indicate. But the result still evaluates to
truthy or falsy.

@return [Boolean]

@version SketchUp 6.0

# File lib/sketchup-api-stubs/stubs/Sketchup/Vertex.rb, line 61
def curve_interior?
end
edges() click to toggle source

The edges method is used to retrieve an Array of edges that use the Vertex.

@example

edge = entities[0]
# Returns array of vertices that make up the line.
verticies = edge.vertices
vertex1 = verticies[0]
edges = vertex1.edges

@return [Array<Sketchup::Edge>] an Array of edge objects if successful

@version SketchUp 6.0

# File lib/sketchup-api-stubs/stubs/Sketchup/Vertex.rb, line 76
def edges
end
faces() click to toggle source

The faces method is used to retrieve an Array of faces that use the vertex.

@example

edge = entities[0]
# Returns array of vertices that make up the line.
verticies = edge.vertices
vertex1 = verticies[0]
faces = vertex1.faces

@return [Array<Sketchup::Face>] an Array of faces that use the vertex if

successful

@version SketchUp 6.0

# File lib/sketchup-api-stubs/stubs/Sketchup/Vertex.rb, line 92
def faces
end
loops() click to toggle source

The loops method is used to retrieve an Array of loops that use the vertex.

@example

edge = entities[0]
# Returns array of vertices that make up the line.
verticies = edge.vertices
vertex1 = verticies[0]
loops = vertex1.loops

@return [Array<Sketchup::Loop>] an Array of loops that use the vertex if

successful

@version SketchUp 6.0

# File lib/sketchup-api-stubs/stubs/Sketchup/Vertex.rb, line 108
def loops
end
position() click to toggle source

The position method is used to retrieve the Point3d position of a vertex.

@example

edge = entities[0]
# Returns array of vertices that make up the line.
verticies = edge.vertices
vertex1 = verticies[0]
position = vertex1.position

@return [Geom::Point3d] a Point3d object representing the position of

the vertex if successful

@version SketchUp 6.0

# File lib/sketchup-api-stubs/stubs/Sketchup/Vertex.rb, line 124
def position
end
used_by?(face_or_edge) click to toggle source

The used_by? method is used to determine if the Vertex is used by a given Edge or Face.

@example

used = vertex1.used_by? my_face

@param [Sketchup::Edge, Sketchup::Face] face_or_edge

A Face or Edge ot test against.

@return [Boolean]

@version SketchUp 6.0

# File lib/sketchup-api-stubs/stubs/Sketchup/Vertex.rb, line 139
def used_by?(face_or_edge)
end