Module fmeobjects :: Class FMEPolygon
[hide private]
[frames] | no frames]

Class FMEPolygon

 object --+            
          |            
FMEGeometry --+        
              |        
        FMEArea --+    
                  |    
      FMESimpleArea --+
                      |
                     FMEPolygon

init(boundary)

FME Polygon class. Create an instance of a Polygon geometry object. The curve passed in is used to define the boundary of the polygon.

Instance Methods [hide private]
 
__init__(boundary)
x.__init__(...) initializes x; see help(type(x)) for signature
None
setBoundary(boundary)
This sets the curve that defines the boundary of the polygon.

Inherited from FMESimpleArea: getBoundaryAsCurve

Inherited from FMEArea: isBoundaryLinear, isConvex, isInPlane, isOriented, isPlanar, offset, orient, removeDuplicates, reverse, rotate2D, scale

Inherited from FMEGeometry: __getObject__, __new__, boundingBox, boundingCube, bounds, clearMeasures, copyAttributesFromFeature, copyNameFromGeometry, copyTraitsFromGeometry, copyTraitsToFeature, deleteName, force2D, force3D, getArea, getMeasureNames, getName, getTrait, getTraitNames, getTraitNullMissingAndType, getTraitType, hasMeasures, hasName, is3D, isCollection, measureExists, removeMeasure, removeTraits, renameMeasure, setName, setTrait, setTraitNullWithType

Inherited from object: __delattr__, __format__, __getattribute__, __hash__, __reduce__, __reduce_ex__, __repr__, __setattr__, __sizeof__, __str__, __subclasshook__

Properties [hide private]

Inherited from object: __class__

Method Details [hide private]

__init__(boundary)
(Constructor)

 

x.__init__(...) initializes x; see help(type(x)) for signature

Parameters:
  • boundary (FMECurve) - The boundary as a curve.

    init(polygon)

    Create a copy of the passed in Polygon geometry object.

    Parameters

    • polygon FMEPolygon - The Polygon geometry object to create a copy of.

    Returns: FMEPolygon

    • An instance of a Polygon Geometry object.
Overrides: object.__init__

setBoundary(boundary)

 

This sets the curve that defines the boundary of the polygon. If this curve is not closed, the closure will be assumed as a straight line from the start point to the end point. This will return an error if the boundary passed in is invalid or None.

Parameters:
  • boundary (FMECurve) - The curve to set as the boundary of the polygon.
Returns: None
Raises:
  • FMEException - An exception is raised if an error occurred.