mapscript.shapeObj

class mapscript.shapeObj(type: int = <MagicMock id='139790538514224'>)

Each feature of a layer’s data is a shapeObj. Each part of the shape is a closed lineObj.

Overview

The shapeObj has the following relationships:

Attributes

bounds	rectObj Bounding box of shape
classindex	int The class index for features of a classified layer
index	long Feature index within the layer
itemdefinitions
numlines	int immutable Number of parts
numvalues	int immutable Number of shape attributes
resultindex	int Index within a query result set
scratch	int TODO Add documentation
text	char Shape annotation
thisown	The membership flag
tileindex	int Index of tiled file for tile-indexed layers
type	int MS_SHAPE_POINT, MS_SHAPE_LINE, MS_SHAPE_POLYGON, or MS_SHAPE_NULL

Methods

Union(shape: shapeObj) → shapeObj

Returns the union of the existing and supplied shape. Shapes must be of the same type. Requires GEOS support. Returns NULL/undef on failure.

__init__(type: int = <MagicMock id='139790538514224'>)

Return a new shapeObj of the specified type. See the type attribute. No attribute values created by default. initValues should be explicitly called to create the required number of values. Each feature of a layer’s data is a shapeObj. Each part of the shape is a closed lineObj

add(line: lineObj) → int

Add line (i.e. a part) to the shape. Returns MS_SUCCESS or MS_FAILURE

boundary() → shapeObj

Returns the boundary of the existing shape. Requires GEOS support. Returns NULL/undef on failure.

buffer(width: double) → shapeObj

Returns a new buffered shapeObj based on the supplied distance (given in the coordinates of the existing shapeObj). Requires GEOS support. Returns NULL/undefined on failure.

clone() → shapeObj

Return an independent copy of the shape.

Note

In the Java & PHP modules this method is named cloneShape.

contains(*args) → int

Overload 1: Returns MS_TRUE if shape2 is entirely inside the shape, returns -1 on error and MS_FALSE otherwise. Requires GEOS support.

Overload 2: Returns MS_TRUE if the point is inside the shape, MS_FALSE otherwise

convexHull() → shapeObj

Returns the convex hull of the existing shape. Requires GEOS support. Returns NULL/undef on failure.

copy(dest: shapeObj) → int

Copy the shape to shape_copy. Returns MS_SUCCESS or MS_FAILURE

crosses(shape: shapeObj) → int

Returns MS_TRUE if shape2 crosses the shape, returns -1 on error and MS_FALSE otherwise. Requires GEOS support.

difference(shape: shapeObj) → shapeObj

Returns the computed difference of the supplied and existing shape. Requires GEOS support. Returns NULL/undef on failure.

disjoint(shape: shapeObj) → int

Returns MS_TRUE if shape and shape2 are disjoint, returns -1 on error and MS_FALSE otherwise. Requires GEOS support.

distanceToPoint(point: pointObj) → double

Returns the distance to point.

distanceToShape(shape: shapeObj) → double

Returns the minimum distance to shape.

draw(map: mapObj, layer: layerObj, image: imageObj) → int

Draws the individual shape using layer. Returns MS_SUCCESS or MS_FAILURE

equals(shape: shapeObj) → int

Returns MS_TRUE if shape and shape2 are equal (geometry only), returns -1 on error and MS_FALSE otherwise. Requires GEOS support.

static fromWKT(wkt: char) → shapeObj

Returns a new shapeObj based on a well-known text representation of a geometry. Requires GEOS support. Returns NULL/undef on failure.

get(i: int) → lineObj

Returns a reference to part at index. Reference is valid only during the life of the shapeObj.

getArea() → double

Returns the area of the shape (if applicable). Requires GEOS support.

getCentroid() → pointObj

Returns the centroid for the existing shape. Requires GEOS support. Returns NULL/undef on failure.

getLabelPoint() → pointObj

Given a shape, return a point object suitable for labelling it.

getLength() → double

Returns the length (or perimeter) of the shape. Requires GEOS support.

getValue(i: int) → char

Return the shape attribute at index i.

initValues(numvalues: int) → void

Allocates memory for the requested number of values.

intersection(shape: shapeObj) → shapeObj

Returns the computed intersection of the supplied and existing shape. Requires GEOS support. Returns NULL/undef on failure.

intersects(shape: shapeObj) → int

Returns MS_TRUE if shape and shape2 intersect, and MS_FALSE otherwise. Does not require GEOS support but will use GEOS functions if available.

overlaps(shape: shapeObj) → int

Returns MS_TRUE if shape2 overlaps shape, returns -1 on error and MS_FALSE otherwise. Requires GEOS support.

project(*args) → int

Overload 1: Reproject shape from proj_in to proj_out. Transformation is done in place. Returns MS_SUCCESS or MS_FAILURE

Overload 2: Reproject shape given a reprojection object. Transformation is done in place. Returns MS_SUCCESS or MS_FAILURE

setBounds() → void

Must be called to calculate new bounding box after new parts have been added. TODO: should return int and set msSetError.

setValue(i: int, value: char) → int

Set the shape value at index i to value.

simplify(tolerance: double) → shapeObj

Given a tolerance, returns a simplified shape object or NULL on error. Requires GEOS support (>=3.0).

symDifference(shape: shapeObj) → shapeObj

Returns the computed symmetric difference of the supplied and existing shape. Requires GEOS support. Returns NULL/undef on failure.

toWKT() → char

Returns the well - known text representation of a shapeObj. Requires GEOS support.Returns NULL / undefined on failure.

topologyPreservingSimplify(tolerance: double) → shapeObj

Given a tolerance, returns a simplified shape object or NULL on error. Requires GEOS support (>=3.0).

touches(shape: shapeObj) → int

Returns MS_TRUE if shape and shape2 touch, returns -1 on error and MS_FALSE otherwise. Requires GEOS support.

within(shape: shapeObj) → int

Returns MS_TRUE if shape is entirely within shape2, returns -1 on error and MS_FALSE otherwise. Requires GEOS support.