Home       Trees       Indices       Help   
FME Objects Python API
Module fmeobjects :: Class FMEPath
[hide private]
[frames] | no frames]

Class FMEPath

init(MultipleInvocations)

Create an instance of an Path geometry object.

init()

Default FMEPath constructor.

Returns: FMEPath

init(path)

Create a copy of the passed in Path geometry object.

Parameters

Returns: FMEPath

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(curve)
Append an entire curve.
None
appendPartWithSnapping(curve)
Append an entire segment.
None
extendToPoint(point)
Extends the path to a point.
None
extendToPointXY(xcoord, ycoord)
Extend the path to a point.
None
extendToPointXYZ(xcoord, ycoord, zcoord)
Extend the path to a point.
None
extendToPointsXY(coords)
Extend the path to a list of points.
None
extendToPointsXYZ(coords)
Extend the path to a list of points.
FMEArc or FMELine
getPartAt(index)
This returns the part of the FMEPath at the given index.
int
numParts()
This returns the number of FMESegments that make up this path.
FMEArc or FMELine
removeEndPart()
This removes the end FMESegment of the path.

Inherited from FMECurve: getAsLine, getAsLineFixedArcSamples, getEndPoint, getLength, getStartPoint, isClosed, isLinear, offset, removeDuplicates, removeMeasure, reverse, rotate2D, scale, setEndPoint, setStartPoint, snip, snipByPoints

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__

appendPart(curve)

 

Append an entire curve. If the path and the curve are not connected, a new line will be inserted between them. If any 3D segments exist, all 2D segments will be converted to 3D with a default Z value of 0.0.

Parameters:
  • curve (FMECurve) - The curve to append.
Returns: None
Raises:
  • FMEException - An exception is raised if an error occurred.

appendPartWithSnapping(curve)

 

Append an entire segment. If the path and the curve are not connected, a the first point on the curve will be moved to instead be the last point on the path. If any 3D segments exist, all 2D segments will be converted to 3D with a default Z value of 0.0.

Parameters:
  • curve (FMECurve) - The curve to append with snapping.
Returns: None
Raises:
  • FMEException - An exception is raised if an error occurred.

extendToPoint(point)

 

Extends the path to a point. If the point is 2D and the path is 3D, the point will be set to 3D with a Z value of 0.0. If the path is 2D and the point is 3D, the segments in the path will be set to 3D with 0.0 for Z values. If None is passed in, nothing will be appended.

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

extendToPointXY(xcoord, ycoord)

 

Extend the path to a point. If this method is called on a 3D line, a Z value of 0.0 will be used for each appended point.

Parameters:
  • xcoord (float) - The x coordinate of the point to be extended to.
  • ycoord (float) - The y coordinate of the point to be extended to.
Returns: None

extendToPointXYZ(xcoord, ycoord, zcoord)

 

Extend the path to a point. If this method is called on a 2D line, the line will be forced to 3D with a default Z value of 0.0.

Parameters:
  • xcoord (float) - The x coordinate of the point to be extended to.
  • ycoord (float) - The y coordinate of the point to be extended to.
  • zcoord (float) - The z coordinate of the point to be extended to.
Returns: None

extendToPointsXY(coords)

 

Extend the path to a list of points. If this method is called on a 3D path, a Z value of 0.0 will be used for each appended point.

Parameters:
  • coords (list of tuple of floats) - The list of 2D points to be extended to.
Returns: None

extendToPointsXYZ(coords)

 

Extend the path to a list of points. If this method is called on a 2D path, the path will be forced to 3D with a default Z value of 0.0.

Parameters:
  • coords (list of tuple of floats) - The list of 3D points to be extended to.
Returns: None

getPartAt(index)

 

This returns the part of the FMEPath at the given index. This returns None if the index is out of range.

Parameters:
  • index (int) - The index to retrieve the part from.
Returns: FMEArc or FMELine
The FMESegment at the given index. Returns the terminal geometry of the FMESegment, either a FMEArc or FMELine.

numParts()

 

This returns the number of FMESegments that make up this path.

Returns: int
The FMESegment at the given index.

removeEndPart()

 

This removes the end FMESegment of the path. If there are no segments in the FMEPath, None is returned.

Returns: FMEArc or FMELine
The FMESegment at the end of the path. Returns the terminal geometry of the FMESegment, either a FMEArc or FMELine.

   Home       Trees       Indices       Help   
FME Objects Python API
Generated by Epydoc 3.0.1 on Thu Apr 20 06:21:03 2017 http://epydoc.sourceforge.net