EdgeUse

class EdgeUse

Parent: Entity | Class Index
Methods:edge, face, loop, next, partners, previous, reversed? |
Sample Code: edgeusetests.rb |

The EdgeUse class defines how an Edge is used in the definition of a Face.

Instance Methods

edge
The edge method is used to retrieve the edge for the edge use.
Syntax:
edge = edgeuse.edge
Arguments:
Return Value:
edge - an Edge object used by this edge use
Comments:
Example:

depth = 100
width = 100
model = Sketchup.active_model
entities = model.active_entities
pts = []
pts[0] = [0, 0, 0]
pts[1] = [width, 0, 0]
pts[2] = [width, depth, 0]
pts[3] = [0, depth, 0]
# Add the face to the entities in the model
face = entities.add_face pts
loop = face.outer_loop
edgeuses = loop.edgeuses
edgeuse = edgeuses[0]
edge = edgeuse.edge
if (edge)
UI.messagebox edge
else
UI.messagebox "Failure"
end

face
The face method is used to retrieve the face used by this edge use.
Syntax:
face = edgeuse.face
Arguments:
Return Value:
face - a Face object used by this edge use
Comments:
Example:

depth = 100
width = 100
model = Sketchup.active_model
entities = model.active_entities
pts = []
pts[0] = [0, 0, 0]
pts[1] = [width, 0, 0]
pts[2] = [width, depth, 0]
pts[3] = [0, depth, 0]
# Add the face to the entities in the model
face = entities.add_face pts
loop = face.outer_loop
edgeuses = loop.edgeuses
edgeuse = edgeuses[0]
face = edgeuse.face
if (face)
UI.messagebox face
else
UI.messagebox "Failure"
end

loop
The loop method is used to retrieve the loop for this edge use.
Syntax:
loop = edgeuse.loop
Arguments:
Return Value:
loop - a Loop object that contains this edge use.
Comments:
Example:

depth = 100
width = 100
model = Sketchup.active_model
entities = model.active_entities
pts = []
pts[0] = [0, 0, 0]
pts[1] = [width, 0, 0]
pts[2] = [width, depth, 0]
pts[3] = [0, depth, 0]
# Add the face to the entities in the model
face = entities.add_face pts
loop = face.outer_loop
edgeuses = loop.edgeuses
edgeuse = edgeuses[0]
loop = edgeuse.loop
if (loop)
UI.messagebox loop
else
UI.messagebox "Failure"
end

next
The next method is used to retrieve the next edge use in a loop.
Syntax:
next = edgeuse.next
Arguments:
Return Value:
next - the next EdgeUse object in a loop
Comments:
Example:

depth = 100
width = 100
model = Sketchup.active_model
entities = model.active_entities
pts = []
pts[0] = [0, 0, 0]
pts[1] = [width, 0, 0]
pts[2] = [width, depth, 0]
pts[3] = [0, depth, 0]
# Add the face to the entities in the model
face = entities.add_face pts
loop = face.outer_loop
edgeuses = loop.edgeuses
edgeuse = edgeuses[0]
eunext = edgeuse.next
if (eunext)
UI.messagebox eunext
else
UI.messagebox "Failure"
end

partners
The partners method is used to retrieve all of the partner edge uses. This method allows you to find all Faces that use an edge.
Syntax:
partners = edgeuse.partners
Arguments:
Return Value:
partners - an array of partner Edge Use objects.
Comments:
Example:

depth = 100
width = 100
model = Sketchup.active_model
entities = model.active_entities
pts = []
pts[0] = [0, 0, 0]
pts[1] = [width, 0, 0]
pts[2] = [width, depth, 0]
pts[3] = [0, depth, 0]
# Add the face to the entities in the model
face = entities.add_face pts
pts2 = []
pts2[0] = [100, 0, 0]
pts2[1] = [200, 0, 0]
pts2[2] = [200, 100, 0]
pts2[3] = [100,100,0]
# Add the face to the entities in the model
face2 = entities.add_face pts2
loop = face.outer_loop
edgeuses = loop.edgeuses
edgeuse = edgeuses[1]
p = edgeuse.partners
if (p)
UI.messagebox p
else
UI.messagebox "Failure"
end

previous
The previous method is used to retrieve the previous edge use in a loop.
Syntax:
edgeuse = edgeuse.previous
Arguments:
Return Value:
edgeuse - the previous Edge Use object in the loop
Comments:
Example:

depth = 100
width = 100
model = Sketchup.active_model
entities = model.active_entities
pts = []
pts[0] = [0, 0, 0]
pts[1] = [width, 0, 0]
pts[2] = [width, depth, 0]
pts[3] = [0, depth, 0]
# Add the face to the entities in the model
face = entities.add_face pts
loop = face.outer_loop
edgeuses = loop.edgeuses
edgeuse = edgeuses[0]
euprevious = edgeuse.previous
if (euprevious)
UI.messagebox euprevious
else
UI.messagebox "Failure"
end

reversed?
The reversed? method is used to determine if the edge is reversed in this use.
Syntax:
status = edgeuse.reversed?
Arguments:
Return Value:
status - true if reversed, false if not reversed.
Comments:
Example:

depth = 100
width = 100
model = Sketchup.active_model
entities = model.active_entities
pts = []
pts[0] = [0, 0, 0]
pts[1] = [width, 0, 0]
pts[2] = [width, depth, 0]
pts[3] = [0, depth, 0]
# Add the face to the entities in the model
face = entities.add_face pts
loop = face.outer_loop
edgeuses = loop.edgeuses
edgeuse = edgeuses[0]
status = edgeuse.reversed?
if (status)
UI.messagebox status
else
UI.messagebox "Failure"
end