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

Class FMEMultiCurve

 object --+    
          |    
FMEGeometry --+
              |
             FMEMultiCurve

init(MultipleInvocations)

Create an instance of a Multi-Curve geometry object.

init()

Default FMEMultiCurve constructor.

Returns: FMEMultiCurve

init(multiCurve)

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

Parameters

Returns: FMEMultiCurve

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)
This appends the curve to the multi curve.
None
appendParts(multiCurve)
This appends the multi curve passed in to the multi curve.
FMECurve of a terminal type or None
getPartAt(index)
This method returns the curve at the given index.
int
numParts()
This returns the number of curves that make up this multi curve.
None
offset(offsetPoint)
Offsets the geometry by the coords specified by offsetPoint.
FMECurve of a terminal type or None
removeLastPart()
This removes and returns the last curve of the multi curve.
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 curve.

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(curve)

 

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

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

appendParts(multiCurve)

 

This appends the multi curve passed in to the multi curve. 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 curve at the given index. None is returned if the index is out of range.

Parameters:
  • index (int) - The index of the curve part to return.
Returns: FMECurve of a terminal type or None
The curve at the given index. Note: This method returns a terminal curve type of the FMECurve; i.e. one of the leaf classes in the FMECurve inheritance graph. For example, a FMELine is returned if the curve truly is a line.
Raises:
  • FMEException - An exception is raised if an error occurred.

numParts()

 

This returns the number of curves that make up this multi curve.

Returns: int
The number of curves in multi curve.

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 curve of the multi curve. If there are no curves in the multi curve, it will return None.

Returns: FMECurve of a terminal type or None
The last curve of the multi curve. Note: This method returns a terminal curve type of the FMECurve; i.e. one of the leaf classes in the FMECurve inheritance graph. For example, a FMELine is returned if the curve truly is a line.
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 curve. 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