Home       Trees       Indices       Help   
Module fmeobjects :: Class FMEMultiPoint
[hide private]
[frames] | no frames]

Class FMEMultiPoint

 object --+    
          |    
FMEGeometry --+
              |
             FMEMultiPoint

init(MultipleInvocations)

Create an instance of a Multi-Point geometry object.

init()

Default FMEMultiPoint constructor.

Returns: FMEMultiPoint

init(multiPoint)

Create a copy of the passed in Multi-Point geometry object.

Parameters

Returns: FMEMultiPoint

Instance Methods [hide private]
 
__decIterRef__(args)
 
__incIterRef__(args)
 
__init__(MultipleInvocations)
x.__init__(...) initializes x; see help(type(x)) for signature
 
__iter__(x)
iter(x)
None
appendPart(point)
This appends the point to the multi point.
None
appendParts(multiPoint)
This appends the multi point passed in to the multi point.
FMEPoint or None
getPartAt(index)
This method returns the point at the given index.
int
numParts()
This returns the number of points that make up this multi point.
None
offset(offsetPoint)
Offsets the geometry by the coords specified by offsetPoint.
FMEPoint or None
removeLastPart()
This removes and returns the last point of the multi point.
None
rotate2D(center, angle)
The angle is CCW up from the horizontal and is measured in degrees.
None
scale(xscale, yscale, zscale)
Applies a scale factor to the multi point.

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__(MultipleInvocations)
(Constructor)

 

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

Overrides: object.__init__

appendPart(point)

 

This appends the point to the multi point. If None is passed in, nothing will be appended. All points in the multi point will be forced to have the same dimension. If any 3D points exist, all 2D points will be converted to 3D with a default Z value of 0.0.

Parameters:
  • point (FMEPoint) - The point to be appended.
Returns: None
Raises:
  • FMEException - An exception is raised if an error occurred.

appendParts(multiPoint)

 

This appends the multi point passed in to the multi point. If None is passed in, nothing will be appended.

Parameters:
Returns: None
Raises:
  • FMEException - An exception is raised if an error occurred.

getPartAt(index)

 

This method returns the point at the given index. None is returned if the index is out of range.

Parameters:
  • index (int) - The index of the point part to return.
Returns: FMEPoint or None
The point at the given index.
Raises:
  • FMEException - An exception is raised if an error occurred.

numParts()

 

This returns the number of points that make up this multi point.

Returns: int
The number of points in multi point.

offset(offsetPoint)

 

Offsets the geometry by the coords specified by offsetPoint.

Parameters:
  • offsetPoint (FMEPoint) - The point to offset the coordinates of the geometry by.
Returns: None
Raises:
  • FMEException - An exception is raised if an error occurred.

removeLastPart()

 

This removes and returns the last point of the multi point. If there are no points in the multi point, it will return None.

Returns: FMEPoint or None
The last point of the multi point.
Raises:
  • FMEException - An exception is raised if an error occurred.

rotate2D(center, angle)

 

The angle is CCW up from the horizontal and is measured in degrees.

Parameters:
  • center (FMEPoint) - The center of the rotation.
  • angle (float) - The angle in degrees.
Returns: None
Raises:
  • FMEException - An exception is raised if an error occurred.

scale(xscale, yscale, zscale)

 

Applies a scale factor to the multi point. The zscale is ignored if geometry is 2D.

Parameters:
  • xscale (float) - The x scale factor.
  • yscale (float) - The y scale factor.
  • zscale (float) - The z scale factor.
Returns: None
Raises:
  • FMEException - An exception is raised if an error occurred.

   Home       Trees       Indices       Help   
Generated by Epydoc 3.0.1 on Thu Nov 26 19:10:16 2015 http://epydoc.sourceforge.net