fmeobjects.FMEBox
This method returns the bounding box of the geometry. 

This method returns the bounding cube of the geometry. 

Returns the bounds of the geometry. 

Remove all measures from the geometry. 

Copies all the attributes from the given feature to traits on this geometry, if they match the (optional) regular expression. 


Copies the name of the 'sourceGeometry' onto this geometry. 
Copies all the traits from the given geometry that match the (optional) regular expression. 


Copies all the traits from this geometry to attributes on the given feature, if they match the (optional) regular expression. 
This routine returns a copy of the given box geometry object. 

Deletes the geometry's name. 

Reduces the geometry to 2D. 


This sets the geometry's dimension to 3D. 
This method returns the appearance reference within the Library associated with this solid. 

Area calculation. 

Returns a boundaryrepresentation solid of this box. 

Gets this box as a 

Returns the wireframe of the solid as a 

Gets the coordinates of this box's center. 

Gets the coordinates of the first point of this box, prior to transformation. 

Returns this box's height (zdirection), prior to transformation. 

Returns this box's length (xdirection), prior to transformation. 

Gets the coordinates of the lower point of this box's bounds as a 

Gets the coordinates of the lower point of this box's bounds prior to transformation. 

Gets the coordinates of the upper point of this box's bounds as a 

Gets the coordinates of the lower point of this box, prior to transformation. 

Gets the coordinates of the second point of this box's bounds prior to transformation. 

Gets the dimensions of this box, prior to transformation. 

Returns this box's length (ydirection), prior to transformation. 

Retrieve the names of the measures on this geometry. 

This routine retrieves the 'name' of this geometry as a 


Retrieves the geometry trait value of the specified trait name. 
Retrieve the names of the traits on this geometry. 


This method returns a tuple of a boolean, indicating if the trait is null, a boolean, indicating if the trait is missing, and an integer representing the type of the trait. 

Returns the type of given trait. 
Gets this box's transformation matrix. 

Check if this geometry or any sub part of this geometry has measures. 

Returns whether or not the geometry has a name. 

This method determines if the box has a transformation matrix or not. 

Returns whether or not the geometry is 3D. 

Check if the geometry is an aggregate or multipart collection. 


Returns 

Returns 

Offsets the solid by the coords specified by 'offsetPoint'. 

Reorients the solid such that either all the surface normals face out from the solid geometry or all the surface normals face in to the solid geometry. 

Removes the measure with name 'measureName' if supplied, or the default measure, if there is one. 

This method has 4 modes: 
Removes this box's transformation matrix. 


Renames the measure specified by 'oldMeasureName' to the new name, specified by 'newMeasureName'. 
Flips the underlying surfaces that make up the solid, such that the front and back of each surface is switched. 

This reverses the order of the solid's points. 


Rotates this solid about the zaxis by the specified angle, in degrees. 

Scale the feature by the given amounts. 

This method associates an appearance within the Library with this solid. 

Sets the coordinates of the lower point of this box's bounds, prior to transformation. 

Sets the coordinates of the upper point of this box's bounds, prior to transformation. 

Sets the geometry's name with a 

Sets a geometry trait with the specified value. 

This method supplies a null trait value with a type to the geometry. 
setTransformationMatrix(matrix), 
 class FMEBox
FME Box Class
Create an instance of a Box geometry object.
init()
Default
FMEBox
constructor. Return type:
 Returns:
An instance of a Box Geometry object.
init(coords)
Creates a box consisting of the tuple of doubles passed in.
 Parameters:
coords (tuple[double]) – The tuple of doubles to set to the box. The coords are represented as a tuple of (firstX, firstY, firstZ, secondX, secondY, secondZ).
 Return type:
 Returns:
An instance of a Box Geometry object.
init(coords, matrix)
Creates a box consisting of the tuple of doubles passed in. With the specified transformation matrix.
 Parameters:
 Return type:
 Returns:
An instance of a Box Geometry object.
init(box)
Create a copy of the passed in Box geometry object.
 Parameters:
box (FMEBox) – The Box geometry object to create a copy of.
 Return type:
 Returns:
An instance of a Box Geometry object.
 __init__(*args, **kwargs)
 boundingBox()
This method returns the bounding box of the geometry.
 boundingCube()
This method returns the bounding cube of the geometry.
 bounds()
Returns the bounds of the geometry.
 clearMeasures()
Remove all measures from the geometry.
 Return type:
None
 copyAttributesFromFeature(sourceFeature, overwriteExisting, regexp, prefix)
Copies all the attributes from the given feature to traits on this geometry, if they match the (optional) regular expression.
 Parameters:
sourceFeature (FMEFeature) – The feature to copy attributes from.
overwriteExisting (bool) – Existing traits will be overwritten only if overwriteExisting is
True
.regexp (str) – (Optional) The regular expression to match the attributes against. If regexp is not specified, then all attributes will be copied.
prefix (str) – (Optional) The prefix is put on all the trait names as they are copied. If it is not specified, a prefix will not be added to the trait names.
 Return type:
None
 copyNameFromGeometry(sourceGeometry)
Copies the name of the ‘sourceGeometry’ onto this geometry. If ‘sourceGeometry’s name is blank or
None
, this geometry’s name will becomeNone
. Parameters:
sourceGeometry (FMEGeometry) – The geometry to copy the name from.
 Return type:
None
 copyTraitsFromGeometry(sourceGeometry, overwriteExisting, regexp, prefix)
Copies all the traits from the given geometry that match the (optional) regular expression.
 Parameters:
sourceGeometry (FMEGeometry) – The geometry to copy traits from.
overwriteExisting (bool) – Existing traits will be overwritten only if overwriteExisting is
True
.regexp (str) – (Optional) The regular expression to match the traits against. If regexp is not specified, or is an empty string, then all traits will be copied.
prefix (str) – (Optional) The prefix is put on all the trait names as they are copied. If it is not specified, a prefix will not be added to the trait names.
 Return type:
None
 copyTraitsToFeature(destFeature, overwriteExisting, regexp, prefix)
Copies all the traits from this geometry to attributes on the given feature, if they match the (optional) regular expression.
 Parameters:
destFeature (FMEFeature) – The feature to copy traits to.
overwriteExisting (bool) – Existing attributes will be overwritten only if overwriteExisting is
True
.regexp (str) – (Optional) The regular expression to match the traits against. If regexp is not specified, or is an empty string, then all traits will be copied.
prefix (str) – (Optional) The prefix is put on all the attribute names as they are copied. If it is not specified, a prefix will not be added to the attribute names.
 Return type:
None
 createBoxCopy()
This routine returns a copy of the given box geometry object. If there are any errors, an exception is raised.
 Return type:
 Returns:
A copy of the box.
 Raises:
FMEException – An exception is raised if an error occurred.
 deleteName()
Deletes the geometry’s name. If a name existed prior to this call then
True
is returned; otherwiseFalse
is returned. Return type:
 Returns:
Returns a boolean indicating whether or not the name existed before deletion.
 force2D()
Reduces the geometry to 2D.
 Return type:
None
 force3D(newZ)
This sets the geometry’s dimension to 3D. All Z values are set to the value passed in, even if the geometry is already 3D.
 Parameters:
newZ (float) – The new Z value.
 Return type:
None
 getAppearanceReference(front)
This method returns the appearance reference within the Library associated with this solid. The front parameter controls whether this query should return the front or the back appearance reference. Both can be fetched independently. If this solid is a regular solid with no geometry instance, a
FMEException
will be thrown. Parameters:
front (bool) – Indicates whether the appearance reference should be fetched for the front or back.
 Return type:
 Returns:
The unique appearance reference for this appearance.
 Raises:
FMEException – An exception is raised if an error occurred or this solid is a regular solid with no geometry instance.
 getAsBRepSolid()
Returns a boundaryrepresentation solid of this box.
 Return type:
 Returns:
The BRepSolid of this box.
 getAsExtrusion()
Gets this box as a
FMEExtrusion
. Return type:
 Returns:
The extrusion representiont this box.
 getAsWireFrame()
Returns the wireframe of the solid as a
FMEMultiCurve
.None
is returned if a wireframe cannot be generated. Return type:
FMEMultiCurve or None
 Returns:
The wireframe of the solid as a
FMEMultiCurve
.
 getCenterPointXYZ()
Gets the coordinates of this box’s center.
 getLocalFirstPointXYZ()
Gets the coordinates of the first point of this box, prior to transformation.
 getLocalHeight()
Returns this box’s height (zdirection), prior to transformation.
 Return type:
 Returns:
The box’s height.
 getLocalLength()
Returns this box’s length (xdirection), prior to transformation.
 Return type:
 Returns:
The box’s length.
 getLocalMaxPoint()
Gets the coordinates of the lower point of this box’s bounds as a
FMEPoint
, prior to transformation. Return type:
 Returns:
The upper point of this box’s bounds.
 getLocalMaxPointXYZ()
Gets the coordinates of the lower point of this box’s bounds prior to transformation.
 getLocalMinPoint()
Gets the coordinates of the upper point of this box’s bounds as a
FMEPoint
, prior to transformation. Return type:
 Returns:
The upper point of this box’s bounds.
 getLocalMinPointXYZ()
Gets the coordinates of the lower point of this box, prior to transformation.
 getLocalSecondPointXYZ()
Gets the coordinates of the second point of this box’s bounds prior to transformation.
 getLocalSize()
Gets the dimensions of this box, prior to transformation. The x, y, and zdirections correspond to length, width, and height, respectively.
 getLocalWidth()
Returns this box’s length (ydirection), prior to transformation.
 Return type:
 Returns:
The box’s width.
 getMeasureNames()
Retrieve the names of the measures on this geometry.
 Return type:
 Returns:
Return a tuple storing the names of the measures on this geometry. This will return an empty tuple if there are no measures. For
FMEAggregate
,FMEMultiSurface
, andFMECompositeSurface
, this will return the union of all measure names of all of its parts.
 getName()
This routine retrieves the ‘name’ of this geometry as a
str
. This will returnNone
if it did not have a name associated with it. Return type:
str or None
 Returns:
The geometry’s name.
 getTrait(traitName)
Retrieves the geometry trait value of the specified trait name. Null trait values will be returned as an empty string. Binary blob traits are returned as a bytearray.
None
is returned when the trait is not found on the geometry.
 getTraitNames()
Retrieve the names of the traits on this geometry.
 getTraitNullMissingAndType(traitName)
This method returns a tuple of a boolean, indicating if the trait is null, a boolean, indicating if the trait is missing, and an integer representing the type of the trait. The first boolean is
True
if ‘traitName’ maps to a null trait value on the geometry. Otherwise it isFalse
. The second boolean isTrue
if ‘traitName’ maps to a no value on the geometry. Otherwise it isFalse
. If the trait is absent,FME_ATTR_UNDEFINED
is returned for the type.The possible trait types are
FME_ATTR_UNDEFINED
,FME_ATTR_BOOLEAN
,FME_ATTR_INT8
,FME_ATTR_UINT8
,FME_ATTR_INT16
,FME_ATTR_UINT16
,FME_ATTR_INT32
,FME_ATTR_UINT32
,FME_ATTR_REAL32
,FME_ATTR_REAL64
,FME_ATTR_REAL80
,FME_ATTR_STRING
,FME_ATTR_ENCODED_STRING
,FME_ATTR_INT64
,FME_ATTR_UINT64
.
 getTraitType(traitName)
Returns the type of given trait. If the trait cannot be found,
FME_ATTR_UNDEFINED
will be returned.Returns one of
FME_ATTR_UNDEFINED
,FME_ATTR_BOOLEAN
,FME_ATTR_INT8
,FME_ATTR_UINT8
,FME_ATTR_INT16
,FME_ATTR_UINT16
,FME_ATTR_INT32
,FME_ATTR_UINT32
,FME_ATTR_REAL32
,FME_ATTR_REAL64
,FME_ATTR_REAL80
,FME_ATTR_STRING
,FME_ATTR_ENCODED_STRING
,FME_ATTR_INT64
,FME_ATTR_UINT64
.
 getTransformationMatrix()
Gets this box’s transformation matrix. If the box does not have such a matrix, an identity matrix is returned. Only the top three rows of the matrix will be returned, as the bottom row is always [ 0 0 0 1 ].
 hasMeasures()
Check if this geometry or any sub part of this geometry has measures.
 hasName()
Returns whether or not the geometry has a name.
 hasTransformationMatrix()
This method determines if the box has a transformation matrix or not.
 is3D()
Returns whether or not the geometry is 3D.
 Return type:
 Returns:
Returns
True
if the geometry is 3D andFalse
otherwise. ForFMENull
, this method will always returnTrue
. ForFMEAggregate
,FMEMultiPoint
,FMEMultiArea
,FMEMultiText
andFMEMultiCurve
, this method will returnTrue
if any one of the subparts is 3D. If the collection is empty or all of its members are 2D, this method will returnFalse
.
 isCollection()
Check if the geometry is an aggregate or multipart collection.
 measureExists(measureName)
Returns
True
if the specified measure exists andFalse
otherwise. If the ‘measureName’ parameter is not specified then the default measure is checked.
 offset(offsetPoint)
Offsets the solid by the coords specified by ‘offsetPoint’.
 Parameters:
offsetPoint (FMEPoint) – The
FMEPoint
to offset the solid by. Return type:
None
 Raises:
FMEException – An exception is raised if an error occurred.
 orient(orientation)
Reorients the solid such that either all the surface normals face out from the solid geometry or all the surface normals face in to the solid geometry.
 Parameters:
orientation (int) – Indicates the desired orientation: 0 for the front side facing out; 1 for the front side facing in.
 Return type:
None
 removeMeasure(measureName)
Removes the measure with name ‘measureName’ if supplied, or the default measure, if there is one.
 Parameters:
measureName (str) – (Optional) The name of the measure to remove.
 Return type:
None
 removeTraits(regexp)
This method has 4 modes:
Remove all traits at the top level: regex == NULL
Remove some traits at the top level: regex == <string>
Remove all traits at all levels: regex ==
kFME_RecurseAll
Remove some traits at all levels: regex ==
kFME_RecurseSome
<string>
For example, specifying regex == NULL for a multisurface will remove all traits at the root level of the multisurface, whereas specifying regex ==
kFME_RecurseSome
<string> will remove all traits from all levels of the multi surface that match <string>. If <string> is an illegal regular expression, no traits will be removed. Return type:
None
 removeTransformationMatrix()
Removes this box’s transformation matrix.
 Return type:
None
 renameMeasure(oldMeasureName, newMeasureName)
Renames the measure specified by ‘oldMeasureName’ to the new name, specified by ‘newMeasureName’.
 reorient()
Flips the underlying surfaces that make up the solid, such that the front and back of each surface is switched. This has the effect of flipping the solid insideout. The front and back vertex normals are swapped.
 Return type:
None
 reverse()
This reverses the order of the solid’s points.
 Return type:
None
 rotate2D(center, angle)
Rotates this solid about the zaxis by the specified angle, in degrees. The rotation is performed relative to the center specified. A positive angle corresponds to a counterclockwise rotation, when looking down onto the XYplane.
 Parameters:
 Return type:
None
 Raises:
FMEException – An exception is raised if an error occurred.
 scale(xScale, yScale, zScale)
Scale the feature by the given amounts.
 Parameters:
 Return type:
None
 Raises:
FMEException – An exception is raised if an error occurred.
 setAppearanceReference(appearanceRef, front)
This method associates an appearance within the Library with this solid. This is done by passing in the unique appearance reference for this appearance. Subsequent calls to this method on the same side, will override the previous appearance used with the new appearance passed in.
An appearance reference of ‘0’ represents the default appearance. Interpretation of the default appearance is left to the consumer of this geometry. When set at this
FMESolid
level, the appearance represents the default appearance to apply when the contained surfaces use the default appearance instead of a specific appearance. Contained surfaces may be found within nested solids, geometry instances that reference geometries containing surfaces, or as surfaces or multisurfaces.The second parameter controls whether this action should take place on the front of the contained surfaces or the back. Both can be set independently. The ‘appearanceRef’ should be a valid reference to a definition stored in the
FMELibrary
. If the reference was not found in the library, it will still attach the reference to the instance, but will throw aFMEException
. This is an unhealthy situation as it represents a ‘dangling reference’. Parameters:
 Return type:
None
 Raises:
FMEException – An exception is raised if an error occurred or the reference was not found in the library and a dangling reference was attached.
 setLocalFirstPointXYZ(x, y, z)
Sets the coordinates of the lower point of this box’s bounds, prior to transformation.
 setLocalSecondPointXYZ(x, y, z)
Sets the coordinates of the upper point of this box’s bounds, prior to transformation.
 setName(name)
Sets the geometry’s name with a
str
. By supplying a blank name as input, this method will act asdeleteName()
. Parameters:
name (str) – The geometry’s new name.
 Return type:
None
 setTrait(traitName, traitValue)
Sets a geometry trait with the specified value. If the geometry trait already exists, its value and type will be changed. The following type numeric mappings are used:
PyInt ==> FME_Int32
PyFloat ==> FME_Real64
PyLong ==> FME_Int64
Binary values are to be specified as bytearray values or bytes values.
 setTraitNullWithType(traitName, traitType)
This method supplies a null trait value with a type to the geometry. If a trait with the same name already exists, it is overwritten.
Trait type must be one of
FME_ATTR_UNDEFINED
,FME_ATTR_BOOLEAN
,FME_ATTR_INT8
,FME_ATTR_UINT8
,FME_ATTR_INT16
,FME_ATTR_UINT16
,FME_ATTR_INT32
,FME_ATTR_UINT32
,FME_ATTR_REAL32
,FME_ATTR_REAL64
,FME_ATTR_REAL80
,FME_ATTR_STRING
,FME_ATTR_ENCODED_STRING
,FME_ATTR_INT64
,FME_ATTR_UINT64
.
 setTransformationMatrix()
setTransformationMatrix(matrix),
Sets this box’s transformation matrix, replacing the existing matrix if it exists. Only three rows are expected in the input array, as a bottom row of [ 0 0 0 1 ] is assumed.