Module fmeobjects :: Class FMEEllipse

Class FMEEllipse

init(MultipleInvocations)

FME Ellipse class.

Create an instance of an Ellipse geometry object.

init(boundary)

This routine creates a new Ellipse geometry object from the passed in arc boundry. If this arc is not closed, the closure will be assumed as a complete continuation of the arc where the end point is 360 degrees from the the start point.

Parameters

boundary (FMEArc) - The boundary as an arc.

Returns: FMEEllipse

An instance of an ellipse geometry object.

init(centerPoint, primaryRadius, secondaryRadius, rotation, orientation)

This routine creates a new Ellipse geometry object using the passed in values.

Parameters

centerPoint (FMEPoint) - The center point.
primaryRadius(float) - The primary radius.
secondaryRadius(float) - The secondary radius.
rotation(float) - The rotation.
orientation(int) - The orientation rule.
Must be either FME_RIGHT_HAND_RULE or FME_LEFT_HAND_RULE.

Returns: FMEEllipse

An instance of an ellipse geometry object.

init(ellipse)

Create a copy of the passed in Ellipse geometry object.

Parameters

ellipse FMEEllipse - The Ellipse geometry object to create a copy of.

Returns: FMEEllipse

An instance of an Ellipse Geometry object.

Instance Methods

[hide private]

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

FMELine or None

getAsLine()
This gets the ellipse as a line.

FMEArc or None

getBoundaryAsArc()
This gets the arc that defines the boundary of the ellipse.

double

getPrimaryRadius()
This gets the primary radius of the ellipse.

double

getRotation()
This gets the rotation of the ellipse.

double

getSecondaryRadius()
This gets the secondary radius of the ellipse.

None

setBoundary(boundary)
This sets the curve that defines the boundary of the ellipse.

None

setPrimaryRadius(primRadius)
This sets the primary radius of the ellipse to primRadius.

None

setRotation(rotation)
This sets the rotation of the ellipse to rotation.

None

setSecondaryRadius(secRadius)
This sets the secondary radius of the ellipse to secRadius.

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

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

Overrides: object.__init__

getAsLine()

This gets the ellipse as a line.

Returns: FMELine or None: The line representing the ellipse or None if the ellipse cannot be returned as a line.

getBoundaryAsArc()

This gets the arc that defines the boundary of the ellipse.

Returns: FMEArc or None: The arc representing the boundary or None if the boundary cannot be returned as an arc.

getPrimaryRadius()

This gets the primary radius of the ellipse. All angles are CCW up from the horizontal and are measured in degrees.

Returns: double: The primary radius.

getRotation()

This gets the rotation of the ellipse. All angles are CCW up from the horizontal and are measured in degrees.

Returns: double: The rotation.

getSecondaryRadius()

This gets the secondary radius of the ellipse. All angles are CCW up from the horizontal and are measured in degrees.

Returns: double: The secondary radius.

setBoundary(boundary)

This sets the curve that defines the boundary of the ellipse. If this arc is not closed, the closure will be assumed as a complete continuation of the arc where the end point is 360 degrees from the the start point. If an error occurs, an exception is thrown.

Parameters:

boundary (FMEArc) - The arc representing the new boundary of the ellipse.

Returns: None

Raises:

FMEException - An exception is raised if an error occurred.

setPrimaryRadius(primRadius)

This sets the primary radius of the ellipse to primRadius. All angles are CCW up from the horizontal and are measured in degrees.

Parameters:

primRadius (float) - The new primary radius.

Returns: None

setRotation(rotation)

This sets the rotation of the ellipse to rotation. All angles are CCW up from the horizontal and are measured in degrees.

Parameters:

rotation (float) - The new rotation.

Returns: None

setSecondaryRadius(secRadius)

This sets the secondary radius of the ellipse to secRadius. All angles are CCW up from the horizontal and are measured in degrees.

Parameters:

secRadius (float) - The new secondary radius.

Returns: None

Class FMEEllipse

__init__(MultipleInvocations) (Constructor)

getAsLine()

getBoundaryAsArc()

getPrimaryRadius()

getRotation()

getSecondaryRadius()

setBoundary(boundary)

setPrimaryRadius(primRadius)

setRotation(rotation)

setSecondaryRadius(secRadius)

init(MultipleInvocations)
(Constructor)