S2Polyline.Shape

Wrapper class for indexing a polyline (see S2ShapeIndex). Once this object is inserted into an S2ShapeIndex it is owned by that index, and will be automatically deleted when no longer needed by the index. Note that this class does not take ownership of the polyline itself (see OwningShape below). You can also subtype this class to store additional data (see S2Shape for details).

class S2Polyline

static

class Shape : S2Shape {

this();

this(S2Polyline polyline);

void init(S2Polyline polyline);

const(S2Polyline) polyline();

int numEdges();

Edge edge(int e);

int dimension();

S2Shape.ReferencePoint getReferencePoint();

int numChains();

Chain chain(int i);

Edge chainEdge(int i, int j);

ChainPosition chainPosition(int e);

}

Constructors

this this(): Undocumented in source.
this this(S2Polyline polyline): Initialization. Does not take ownership of "polyline".

Members

Functions

chain Chain chain(int i): Undocumented in source.
chainEdge Edge chainEdge(int i, int j): Undocumented in source.
chainPosition ChainPosition chainPosition(int e): Undocumented in source. Be warned that the author may not have intended to support it.
dimension int dimension(): Undocumented in source. Be warned that the author may not have intended to support it.
edge Edge edge(int e): Undocumented in source. Be warned that the author may not have intended to support it.
getReferencePoint S2Shape.ReferencePoint getReferencePoint(): Undocumented in source. Be warned that the author may not have intended to support it.
init void init(S2Polyline polyline): Undocumented in source. Be warned that the author may not have intended to support it.
numChains int numChains(): Undocumented in source. Be warned that the author may not have intended to support it.
numEdges int numEdges(): Undocumented in source. Be warned that the author may not have intended to support it.
polyline const(S2Polyline) polyline(): Undocumented in source. Be warned that the author may not have intended to support it.

Inherited Members

From S2Shape

Edge struct Edge: An edge, consisting of two vertices "v0" and "v1". Zero-length edges are allowed, and can be used to represent points.
Chain struct Chain: A range of edge ids corresponding to a chain of zero or more connected edges, specified as a (start, length) pair. The chain is defined to consist of edge ids {start, start + 1, ..., start + length - 1}.
ChainPosition struct ChainPosition: The position of an edge within a given edge chain, specified as a (chain_id, offset) pair. Chains are numbered sequentially starting from zero, and offsets are measured from the start of each chain.
ReferencePoint struct ReferencePoint: A ReferencePoint consists of a point P and a boolean indicating whether P is contained by a particular shape.
numEdges int numEdges(): Returns the number of edges in this shape. Edges have ids ranging from 0 to num_edges() - 1.
edge Edge edge(int edge_id): Returns the endpoints of the given edge id.
dimension int dimension(): Returns the dimension of the geometry represented by this shape.
hasInterior bool hasInterior(): Convenience function that returns true if this shape has an interior.
getReferencePoint ReferencePoint getReferencePoint(): Returns an arbitrary point P along with a boolean indicating whether P is contained by the shape. (The boolean value must be false for shapes that do not have an interior.)
numChains int numChains(): Returns the number of contiguous edge chains in the shape. For example, a shape whose edges are [AB, BC, CD, AE, EF] would consist of two chains (AB,BC,CD and AE,EF). Every chain is assigned a "chain id" numbered sequentially starting from zero.
chain Chain chain(int chain_id): Returns the range of edge ids corresponding to the given edge chain. The edge chains must form contiguous, non-overlapping ranges that cover the entire range of edge ids. This is spelled out more formally below:
chainEdge Edge chainEdge(int chain_id, int offset): Returns the edge at offset "offset" within edge chain "chain_id". Equivalent to "shape.edge(shape.chain(chain_id).start + offset)" but may be more efficient.
chainPosition ChainPosition chainPosition(int edge_id): Finds the chain containing the given edge, and returns the position of that edge as a (chain_id, offset) pair.
id int id(): A unique id assigned to this shape by S2ShapeIndex. Shape ids are assigned sequentially starting from 0 in the order shapes are added.
userData const(void*) userData(): Virtual methods that return pointers of your choice.
mutableUserData void* mutableUserData(): Undocumented in source. Be warned that the author may not have intended to support it.
_id int _id;: Assigned by MutableS2ShapeIndex when the shape is added.