Edge

class itasca.geometry.edge.Edge

Objects of this type should not be created (instantiated) directly in Python. Use the module functions that return instances of this type.

closest(vec: pos) → vec.

Return the point on the edge closes to the point pos.

dir() → vec.

Get the geometry edge edge dirction (vector).

dir_x() → float.

Get the x-component of the geometry edge edge dirction.

dir_y() → float.

Get the y-component of the geometry edge edge dirction.

dir_z() → float.

Get the z-component of the geometry edge edge dirction.

extra(slot: int) → any.

Get the geometry edge extra data in the given slot.

group([slot: str or int]) → str.

Get the geometry edge group name in a given slot.

group_remove(group_name: str or int[, slot: str or int]) → bool.

Remove from the given group from all group slots of the geometry edge. One argument of type string, giving the group name, is required. The return value is a bool which is True if the group was removed from any slot, otherwise False.

groups() → {slot: group_name}.

Get a dictionary describing which groups this geometry edge is part of. The keys of the dictionary are the slot names and the values are the group names.

id() → int.

Get the geometry edge id.

in_group(group_name: str or int[, slot: str or int]) → bool.

Test if the geometry edge is part of a given group. If the optional argument slot is given, only that slot is searched. Otherwise, all group slots are searched.

length() → double.

Get the edge legnth.

next_edge(int: i) → Geometry edge object.

Get the next edge connected to the node with local index i within the source edge.

next_index(int: i) → int.

Get the local index of the point within the next edge connected to this point(the same point with local index i within the source edge).

node(int: i) → Geometry node object.

Get an edge node with the local index i.

node_pos(int: i) → vec.

Get the position of an edge node with the local index i.

pos() → vec.

Get the geometry edge location (vector).

pos_x() → float.

Get the x-component of the geometry edge location.

pos_y() → float.

Get the y-component of the geometry edge location.

pos_z() → float.

Get the z-component of the geometry edge location.

set_extra(slot: int, value: any) → None.

Set the geometry edge extra data in the given slot.

set_group(group_name: str or int[, slot: str or int]) → None.

Set the geometry edge group name in a given slot.

start_index() → int.

Get the local index of the geometry edge within the first edge attached to it.

start_poly() → Geometry poly object.

Get the first polygon connected to a geometry edge.

valid() → bool.

Returns True if this geometry edge is live.