Module fmeobjects :: Class FMEMultiText

[frames] | no frames]

Class FMEMultiText

init(MultipleInvocations)

Create an instance of a Multi-Text geometry object.

init()

Default FMEMultiText constructor.

Returns: FMEMultiText

An instance of a MultiText geometry object.

init(multiText)

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

Parameters

multiText FMEMultiText - The Multi-Text geometry object to create a copy of.

Returns: FMEMultiText

An instance of a MultiText Geometry object.

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(text)
This appends the text to the multi text.

None

appendParts(multiText)
This appends the multi text passed in to the multi text.

FMEText of a terminal type or None

getPartAt(index)
This method returns the text at the given index.

int

numParts()
This returns the number of texts that make up this multi text.

None

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

FMEText of a terminal type or None

removeLastPart()
This removes and returns the last text of the multi text.

None

rotate2D(center, angle)
The angle is CCW up from the horizontal and is measured in degrees.

None

scaleXYZ(xscale, yscale, zscale)
Applies a scale factor to the multi text.

None

scaleXYZT(xscale, yscale, zscale, scaleText)
Applies a scale factor to the multi text.

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

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

Parameters:

text (FMEText) - The text to be appended.

Returns: None

Raises:

FMEException - An exception is raised if an error occurred.

appendParts(multiText)

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

Parameters:

multiText (FMEMultiText) - The multi text to be appended.

Returns: None

Raises:

FMEException - An exception is raised if an error occurred.

getPartAt(index)

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

Parameters:

index (int) - The index of the text part to return.

Returns: FMEText of a terminal type or None

The text at the given index. Note: This method returns a terminal text type of the FMEText; i.e. one of the leaf classes in the FMEText inheritance graph. For example, a FMELine is returned if the text truly is a line.

Raises:

FMEException - An exception is raised if an error occurred.

numParts()

This returns the number of texts that make up this multi text.

Returns: int: The number of texts in multi text.

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

Returns: FMEText of a terminal type or None

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

scaleXYZ(xscale, yscale, zscale)

Applies a scale factor to the multi text. 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.

scaleXYZT(xscale, yscale, zscale, scaleText)

Applies a scale factor to the multi text. 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.
scaleText (bool) - bool indicating whether of not to scale the text.

Returns: None

Raises:

FMEException - An exception is raised if an error occurred.

Class FMEMultiText

__init__(MultipleInvocations) (Constructor)

appendPart(text)

appendParts(multiText)

getPartAt(index)

numParts()

offset(offsetPoint)

removeLastPart()

rotate2D(center, angle)

scaleXYZ(xscale, yscale, zscale)

scaleXYZT(xscale, yscale, zscale, scaleText)

init(MultipleInvocations)
(Constructor)