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

Class FMETriangleStrip

init(MultipleInvocations)

Create an instance of a Triangle Strip geometry object.

init()

Default FMETriangleStrip constructor.

Returns: FMETriangleStrip

init(points)

Creates a line consisting of the list of points passed in.

Parameters

Returns: FMETriangleStrip

init(triangleStrip)

Create a copy of the passed in Triangle Strip geometry object.

Parameters

Returns: FMETriangleStrip

Instance Methods [hide private]
 
__init__(MultipleInvocations)
x.__init__(...) initializes x; see help(type(x)) for signature
None
appendPointXYZ(x, y, z)
Appends coordinates to the end of the coordinate list that defines the triangle strip.
None
appendPointsXYZ(points)
Appends coordinates to the end of the coordinate list that defines the triangle strip.
FMEFace or None
getAsFaceAt(index)
Returns a triangular face defined by this triangle strip.
float
getMeasureValueAt(index, measureName)
Get the value of the default measure at the 'index'.
list of float
getMeasureValues(measureName)
Returns the value of the default measure, or the measure named by 'measureName'.
tuple of floats
getPointAtXYZ(index)
Gets a coordinate of this triangle strip at the specified index.
list of FMEPoint
getPoints()
Gets the points of the triangle strip as a list of FMEPoint objects.
FMELine
getPointsAsLine()
Returns a line that contains the points in this triangle strip.
bool
isFlipped()
Determines whether the orientation of the triangle strip is the opposite of what the first triangle indicates (using a right-handed coordinate system).
int
numPoints()
Returns the number of coordinates in this triangle strip.
None
setMeasure(measureValues, measureName)
Set the default measure to the given values.
None
setMeasureAt(index, measureValue, measureName)
Set the default measure of the point at 'index' to the given 'measureValue'.

Inherited from FMESimpleSurface: numParts

Inherited from FMESurface: __decIterRef__, __incIterRef__, __iter__, deleteSide, getAppearanceReference, getAsWireFrame, isInPlane, isOriented, isPlanar, offset, orient, reorient, reverse, rotate2D, scale, setAppearanceReference, sideExists

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__

appendPointXYZ(x, y, z)

 

Appends coordinates to the end of the coordinate list that defines the triangle strip. This operation effectively appends new triangles to the triangle strip. After the append operation, coordinates at indices 0, i + 1, and i + 2 define the ith triangle.

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

appendPointsXYZ(points)

 

Appends coordinates to the end of the coordinate list that defines the triangle strip. This operation effectively appends new triangles to the triangle strip. After the append operation, coordinates at indices 0, i + 1, and i + 2 define the ith triangle.

Parameters:
  • points (list of tuple of float) - The list of points to be added. The points are represented as (x, y, z) tuples.
Returns: None

getAsFaceAt(index)

 

Returns a triangular face defined by this triangle strip. The index indicates the specific triangular face to return. In particular, given an index i, the triangular face returned is specified by the coordinate indices 0, i + 1, and i + 2. If the specified index is out of range, then None is returned.

Parameters:
  • index (int) - The index to get the copy at.
Returns: FMEFace or None
A copy of a triangular face defined by this triangle strip.

getMeasureValueAt(index, measureName)

 

Get the value of the default measure at the 'index'. If 'measureName' is supplied, this method gets the value of the named measure at 'index'. Returns an error if the measure doesn't exist or 'index' is out of range.

Parameters:
  • index (int) - The index where to retrieve the value from.
  • measureName (string) - (Optional) The name of the measure whose value is to be returned.
Returns: float
The value of the default measure at the given index, or the measure named by 'measureName' at the given index.
Raises:
  • FMEException - An exception is raised if an error occurred.

getMeasureValues(measureName)

 

Returns the value of the default measure, or the measure named by 'measureName'.

Parameters:
  • measureName (string) - (Optional) The name of the measure whose value is to be returned.
Returns: list of float
The values of the default measure, or the measures named by 'measureName'.
Raises:
  • FMEException - An exception is raised if an error occurred.

getPointAtXYZ(index)

 

Gets a coordinate of this triangle strip at the specified index. If index is out of range, then an error is generated.

Parameters:
  • index (int) - The index to get the point from.
Returns: tuple of floats
The point is represented as a (x, y, z) tuple.

getPoints()

 

Gets the points of the triangle strip as a list of FMEPoint objects. The size of the given list must be exactly equal to the value returned by numPoints(). If the triangle strip is 2D the z values of the triangle strip will be populated with 0.0 values. Throws an exception if an error occurred.

Returns: list of FMEPoint
A list of the points contained within the triangle strip.
Raises:
  • FMEException - An exception is raised if an error occurred.

getPointsAsLine()

 

Returns a line that contains the points in this triangle strip. The line will have all the geometry traits and measures of the triangle strip.

Returns: FMELine
A copy of a line that contains the points in this triangle strip.

isFlipped()

 

Determines whether the orientation of the triangle strip is the opposite of what the first triangle indicates (using a right-handed coordinate system).

Returns: bool
Returns True if the orientation of the triangle strip is the opposite of what the first triangle indictes and False otherwise.

numPoints()

 

Returns the number of coordinates in this triangle strip.

Returns: int
The number of points in this triangle strip.

setMeasure(measureValues, measureName)

 

Set the default measure to the given values. Create the measure if it doesn't already exist. If 'measureName' is supplied, this method sets the given measure to 'measureValues', or creates the measure if it doesn't already exist. The size of measureValues must be exactly equal to the value returned by numPoints().

Parameters:
  • measureValues (list of float) - The values of the measure.
  • measureName (string) - (Optional) The name of the measure whose value is to be set, or created.
Returns: None

setMeasureAt(index, measureValue, measureName)

 

Set the default measure of the point at 'index' to the given 'measureValue'. If 'measureName' is supplied, this method sets the given measure of the point at 'index' to 'measureValue'. Creates the measure if it doesn't already exist and set the measures to all points other than the point at the given index to None. Return an error if the index is out of range.

Parameters:
  • index (int) - The index of the measure to set.
  • measureValue (float) - The value of the measure.
  • measureName (string) - (Optional) The name of the measure whose value is to be set, or created.
Returns: None
Raises:
  • FMEException - An exception is raised if an error occurred.

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