mapscript.shapeObj

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

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:

../../../_images/shapeObj_lineObj.png

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[sumber]

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='140644742090512'>)[sumber]

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[sumber]

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

boundary() shapeObj[sumber]

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

buffer(width: double) shapeObj[sumber]

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[sumber]

Return an independent copy of the shape.

contains(*args) int[sumber]

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[sumber]

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

copy(dest: shapeObj) int[sumber]

Copy the shape to shape_copy. Returns MS_SUCCESS or MS_FAILURE

crosses(shape: shapeObj) int[sumber]

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

difference(shape: shapeObj) shapeObj[sumber]

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

disjoint(shape: shapeObj) int[sumber]

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

distanceToPoint(point: pointObj) double[sumber]

Returns the distance to point.

distanceToShape(shape: shapeObj) double[sumber]

Returns the minimum distance to shape.

draw(map: mapObj, layer: layerObj, image: imageObj) int[sumber]

Draws the individual shape using layer. Returns MS_SUCCESS or MS_FAILURE

equals(shape: shapeObj) int[sumber]

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[sumber]

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[sumber]

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

getArea() double[sumber]

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

getCentroid() pointObj[sumber]

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

getLabelPoint() pointObj[sumber]

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

getLength() double[sumber]

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

getValue(i: int) char[sumber]

Return the shape attribute at index i.

initValues(numvalues: int) void[sumber]

Allocates memory for the requested number of values.

intersection(shape: shapeObj) shapeObj[sumber]

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

intersects(shape: shapeObj) int[sumber]

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[sumber]

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

project(projin: projectionObj, projout: projectionObj) int[sumber]

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

setBounds() void[sumber]

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[sumber]

Set the shape value at index i to value.

simplify(tolerance: double) shapeObj[sumber]

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

symDifference(shape: shapeObj) shapeObj[sumber]

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

toWKT() char[sumber]

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

topologyPreservingSimplify(tolerance: double) shapeObj[sumber]

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

touches(shape: shapeObj) int[sumber]

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

within(shape: shapeObj) int[sumber]

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