Module fmeobjects :: Class FMEPoint

Class FMEPoint

 object --+    
          |    
FMEGeometry --+
              |
             FMEPoint

init(MultipleInvocations)

FME Point class.

Create an instance of a Point geometry object.

init()

Default FMEPoint constructor.

Returns: FMEPoint

An instance of a Point Geometry object.

init(x,y,z)

Creates a point with the given xyz coordinates.

Parameters

x (float) - The x value to set.
y (float) - The y value to set.
z (float) - (Optional) The z value to set.

Returns: FMEPoint

An instance of a Point Geometry object.

init(point)

Create a copy of the passed in Point geometry object.

Parameters

point FMEPoint - The Point geometry object to create a copy of.

Returns: FMEPoint

An instance of a Point Geometry object.

Instance Methods

[hide private]

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

bool

equalCoordinate(point, checkZ)
Returns True if the two points have the identical coordinate.

bool

equals(point)
Returns True if the two points have the identical coordinate and measures.

float

getMeasureValue(measureName)
Returns the value of the default measure, or the measure named by 'measureName'.

tuple of floats

getXYZ()
Get the coordinate value.

None

offset(offsetPoint)
Offsets the geometry by the coords specified by offsetPoint.

None

removeMeasure(measureName)
Remove the specified measure.

None

reset(point)
Set the coordinate and measure values to the values in the given point.

None

rotate2D(center, angle)
Rotates the point.

None

scale(xScale, yScale, zScale)
zScale is ignored if geometry is 2D.

None

setMeasure(measureValue, measureName)
Sets the value of the default measure, or creates the default measure if it doesn't exist.

None

setX(newX)
Set the x coordinate value.

None

setXYZ(newX, newY, newZ)
Set the coordinate value.

None

setXYZAsTuple(point)
Set the coordinate value as a tuple.

None

setY(newY)
Set the y coordinate value.

None

setZ(newZ)
Set the z coordinate value.

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, 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__

equalCoordinate(point, checkZ)

Returns True if the two points have the identical coordinate. Z are checked only if checkZ is True Measures are not compared.

Parameters:

point (FMEPoint) - The point to compare to.
checkZ (bool) - If set to True, z coordinate values will be checked.

Returns: bool

True if the two points have identical coordinates, False otherwise.

equals(point)

Returns True if the two points have the identical coordinate and measures.

Parameters:

point (FMEPoint) - The other point to compare to.

Returns: bool

True if the two points have identical coordinate and measures, False otherwise.

getMeasureValue(measureName)

Returns the value of the default measure, or the measure named by 'measureName'.

Parameters:

measureName (string) - (Optional) The name of the measure whose value is to be returned.

Returns: float

The value of the default measure, or the measure named by 'measureName'.

Raises:

FMEException - An exception is raised if an error occurred.

getXYZ()

Get the coordinate value. 0.0 is returned for the z value if the point is 2D.

Returns: tuple of floats: The coordinate value of the point.

offset(offsetPoint)

Offsets the geometry by the coords specified by offsetPoint.

Parameters:

offsetPoint (FMEPoint) - The offset point.

Returns: None

Raises:

FMEException - An exception is raised if an error occurred.

removeMeasure(measureName)

Remove the specified measure. If 'measureName' is not supplied, remove the the default measure.

Parameters:

measureName (string) - (Optional) The name of the measure to be removed.

Returns: None

Overrides: FMEGeometry.removeMeasure

reset(point)

Set the coordinate and measure values to the values in the given point. The point is forced to 3D if necessary. All existing measures are lost.

Parameters:

point (FMEPoint) - The point to reset the coordinate and measure values to.

Returns: None

rotate2D(center, angle)

Rotates the point.

Parameters:

center (FMEPoint) - The center point.
angle (float) - The to rotate by. The angle is counter-clockwise up from the horizontal, and measured in degrees.

Returns: None

Raises:

FMEException - An exception is raised if an error occurred.

scale(xScale, yScale, zScale)

zScale is ignored if geometry is 2D.

Parameters:

xScale (float) - The value to scale x by.
yScale (float) - The value to scale y by.
zScale (float) - (Optional) The value to scale z by.

Returns: None

Raises:

FMEException - An exception is raised if an error occurred.

setMeasure(measureValue, measureName)

Sets the value of the default measure, or creates the default measure if it doesn't exist. If a measureName is supplied, this method sets the value of the named measure, or creates the measure if it doesn't exist.

Parameters:

measureValue (float) - The value of the measure
measureName (string) - (Optional) The name of the measure whose value is to be set, or created.

Returns: None

setX(newX)

Set the x coordinate value.

Parameters:

newX (float) - The new X value.

Returns: None

setXYZ(newX, newY, newZ)

Set the coordinate value. The point is forced to 3D if necessary.

Parameters:

newX (float) - The new x value.
newY (float) - The new y value.
newZ (float) - (Optional) The new z value.

Returns: None

setXYZAsTuple(point)

Set the coordinate value as a tuple. The point is forced to 3D if necessary.

Parameters:

point (tuple of floats) - The tuple to set the point to.

Returns: None

setY(newY)

Set the y coordinate value.

Parameters:

newY (float) - The new y value.

Returns: None

setZ(newZ)

Set the z coordinate value.

Parameters:

newZ (float) - The new z value.

Returns: None

Class FMEPoint

__init__(MultipleInvocations) (Constructor)

equalCoordinate(point, checkZ)

equals(point)

getMeasureValue(measureName)

getXYZ()

offset(offsetPoint)

removeMeasure(measureName)

reset(point)

rotate2D(center, angle)

scale(xScale, yScale, zScale)

setMeasure(measureValue, measureName)

setX(newX)

setXYZ(newX, newY, newZ)

setXYZAsTuple(point)

setY(newY)

setZ(newZ)

init(MultipleInvocations)
(Constructor)