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

Class FMEBox

init(MultipleInvocations)

Create an instance of a Box geometry object.

init()

Default FMEBox constructor.

Returns: FMEBox

init(coords)

Creates a box consisting of the tuple of doubles passed in.

Parameters

Returns: FMEBox

init(coords, matrix)

Creates a box consisting of the tuple of doubles passed in. With the specified transformation matrix.

Parameters

Returns: FMEBox

init(box)

Create a copy of the passed in Box geometry object.

Parameters

Returns: FMEBox

Instance Methods [hide private]
 
__init__(MultipleInvocations)
x.__init__(...) initializes x; see help(type(x)) for signature
FMEBox
createBoxCopy()
This routine returns a copy of the given box geometry object.
FMEBRepSolid
getAsBRepSolid()
Returns a boundary-representation solid of this box.
FMEBRepSolid
getAsExtrusion()
Gets this box as a FMEExtrusion.
tuple of floats
getCenterPointXYZ()
Gets the coordinates of this box's center.
tuple of floats
getLocalFirstPointXYZ()
Gets the coordinates of the first point of this box, prior to transformation.
float
getLocalHeight()
Returns this box's height (z-direction), prior to transformation.
float
getLocalLength()
Returns this box's length (x-direction), prior to transformation.
FMEPoint
getLocalMaxPoint()
Gets the coordinates of the lower point of this box's bounds as a FMEPoint, prior to transformation.
tuple of floats
getLocalMaxPointXYZ()
Gets the coordinates of the lower point of this box's bounds prior to transformation.
FMEPoint
getLocalMinPoint()
Gets the coordinates of the upper point of this box's bounds as a FMEPoint, prior to transformation.
tuple of floats
getLocalMinPointXYZ()
Gets the coordinates of the lower point of this box, prior to transformation.
tuple of floats
getLocalSecondPointXYZ()
Gets the coordinates of the second point of this box's bounds prior to transformation.
tuple of floats
getLocalSize()
Gets the dimensions of this box, prior to transformation.
float
getLocalWidth()
Returns this box's length (y-direction), prior to transformation.
list of lists of floats
getTransformationMatrix()
Gets this box's transformation matrix.
bool
hasTransformationMatrix()
This method determines if the box has a transformation matrix or not.
None
removeTransformationMatrix()
Removes this box's transformation matrix.
None
setLocalMaxPointXYZ(x, y, z)
Sets the coordinates of the upper point of this box's bounds, prior to transformation.
None
setLocalMinPointXYZ(x, y, z)
Sets the coordinates of the lower point of this box's bounds, prior to transformation.
 
setTransformationMatrix(matrix)
Sets this box's transformation matrix, replacing the existing matrix if it exists.

Inherited from FMESolid: getAppearanceReference, getAsWireFrame, offset, reverse, rotate2D, scale, setAppearanceReference

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__

createBoxCopy()

 

This routine returns a copy of the given box geometry object. If there are any errors, an exception is raised.

Returns: FMEBox
A copy of the box.
Raises:
  • FMEException - An exception is raised if an error occurred.

getAsBRepSolid()

 

Returns a boundary-representation solid of this box.

Returns: FMEBRepSolid
The BRepSolid of this box.

getAsExtrusion()

 

Gets this box as a FMEExtrusion.

Returns: FMEBRepSolid
The extrusion representiont this box.

getCenterPointXYZ()

 

Gets the coordinates of this box's center.

Returns: tuple of floats
A tuple of the center point's x, y and z coordinates consecutively, formatted (x, y, z).

getLocalFirstPointXYZ()

 

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

Returns: tuple of floats
A tuple of the first point's x, y and z coordinates consecutively, formatted (x, y, z).

getLocalHeight()

 

Returns this box's height (z-direction), prior to transformation.

Returns: float
The box's height.

getLocalLength()

 

Returns this box's length (x-direction), prior to transformation.

Returns: float
The box's length.

getLocalMaxPoint()

 

Gets the coordinates of the lower point of this box's bounds as a FMEPoint, prior to transformation.

Returns: FMEPoint
The upper point of this box's bounds.

getLocalMaxPointXYZ()

 

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

Returns: tuple of floats
A tuple of the lower point's x, y and z coordinates consecutively, formatted (x, y, z).

getLocalMinPoint()

 

Gets the coordinates of the upper point of this box's bounds as a FMEPoint, prior to transformation.

Returns: FMEPoint
The upper point of this box's bounds.

getLocalMinPointXYZ()

 

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

Returns: tuple of floats
A tuple of the upper point's x, y and z coordinates consecutively, formatted (x, y, z).

getLocalSecondPointXYZ()

 

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

Returns: tuple of floats
A tuple of the second point's x, y and z coordinates consecutively, formatted (x, y, z).

getLocalSize()

 

Gets the dimensions of this box, prior to transformation. The x-, y-, and z-directions correspond to length, width, and height, respectively.

Returns: tuple of floats
A tuple of the box's length, width and height respectively.

getLocalWidth()

 

Returns this box's length (y-direction), prior to transformation.

Returns: float
The box's width.

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 ].

Returns: list of lists of floats
The box's tranformation matrix, formatted [[dddd][dddd][dddd]].

hasTransformationMatrix()

 

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

Returns: bool
Returns True if this box has a transformation matrix, and False otherwise.

setLocalMaxPointXYZ(x, y, z)

 

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

Parameters:
  • x (float) - The x coordinate of the upper point.
  • y (float) - The y coordinate of the upper point.
  • z (float) - The z coordinate of the upper point.
Returns: None

setLocalMinPointXYZ(x, y, z)

 

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

Parameters:
  • x (float) - The x coordinate of the lower point.
  • y (float) - The y coordinate of the lower point.
  • z (float) - The z coordinate of the lower point.
Returns: None

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.

Parameters:
  • matrix (list of lists of floats) - The transformation matrix, formatted [[dddd][dddd][dddd]].@rtype: None

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