mapscript.shapeObj¶
- class mapscript.shapeObj(type: int = <MagicMock id='140476470106416'>)¶
Each feature of a layer’s data is a
shapeObj
. Each part of the shape is a closedlineObj
.Overview
The shapeObj has the following relationships:
Attributes
bounds
rectObj
Bounding box of shapeclassindex
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='140476470106416'>)[исходный код]¶
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
orMS_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.
Примечание
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 andMS_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
orMS_FAILURE
- crosses(shape: shapeObj) int [исходный код]¶
Returns
MS_TRUE
if shape2 crosses the shape, returns -1 on error andMS_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 andMS_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
orMS_FAILURE
- equals(shape: shapeObj) int [исходный код]¶
Returns
MS_TRUE
if shape and shape2 are equal (geometry only), returns -1 on error andMS_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, andMS_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 andMS_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
orMS_FAILURE
Overload 2: Reproject shape given a reprojection object. Transformation is done in place. Returns
MS_SUCCESS
orMS_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 andMS_FALSE
otherwise. Requires GEOS support.
- within(shape: shapeObj) int [исходный код]¶
Returns
MS_TRUE
if shape is entirely within shape2, returns -1 on error andMS_FALSE
otherwise. Requires GEOS support.