fmeobjects.FMEMesh
|
This routine adds a new mesh part to the mesh. |
|
This routine extends the functionality of |
|
Appends a mesh passed in to the mesh, by appending the vertices, vertex normals and texture coordinates and then by appending mesh parts with updated indices. |
|
Appends the texture coordinate to the end of the texture coordinate list. |
|
Appends the texture coordinates to the end of the texture coordinate list. |
|
Appends the point to the end of the vertex list. |
|
Appends the point to the end of the vertex list using color information provided. |
|
Appends the point to the end of the vertex normal list. |
|
Appends the vertex normals to the end of the vertex normal list. |
|
Appends the vertices to the end of the vertex list. |
Appends the vertices to the end of the vertex list using color information provided. |
|
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 label 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. |
Deletes the geometry's label. |
|
|
This method deletes the side specified by 'front' and indicates whether or not it existed before being deleted. |
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 surface. |
|
Area calculation. |
|
Returns a composite surface representation of this mesh. |
|
Returns a multi-surface representation of this mesh. |
|
Returns the wireframe of the surface as a |
|
This routine retrieves the 'label' of this geometry as a |
|
Retrieve the names of the measures on this geometry. |
|
getTextureCoordinateAt(index), |
|
Retrieves the texture coordinate list with texture coordinates in the same index position as referenced by the faces. |
|
|
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 mesh's transformation matrix. |
|
|
Retrieve the vertex, in global coordinates (i.e., the transformation matrix is applied, if it exists), at the specified index. |
|
Retrieves the vertex color at the specified index. |
|
Retrieve the vertex normal, in global coordinates (i.e., the transformation matrix is applied, if it exists), at the specified index. |
Retrieves the vertex normal list with vertex normals, in global coordinates (i.e., the transformation matrix is applied, if it exists), in the same index position as referenced by the faces. |
|
This is the same as |
|
Retrieves the vertex list with vertices, in global coordinates (i.e., the transformation matrix is applied, if it exists), in the same index position as referenced by the faces. |
|
This is the same as |
|
|
This method determines if there is color at a vertex. |
Returns whether or not the geometry has a label. |
|
Check if this geometry or any sub part of this geometry has measures. |
|
Returns |
|
Returns |
|
Returns |
|
Returns |
|
This method determines if the mesh has a transformation matrix or not. |
|
Returns whether or not the geometry is 3D. |
|
Check if the geometry is an aggregate or multi-part collection. |
|
|
Works similarly to |
A face with a donut area will not be oriented if the normal of any inner boundary has the same direction as the normal of the outer boundary. |
|
|
Returns |
Returns the maximum number of edges the mesh can contain. |
|
|
Returns |
This returns the number of faces that are contained in this simple surface. |
|
Returns the number of texture coordinates that are contained in this mesh. |
|
Returns the total number of vertex colors, including invalid ones. |
|
Returns the number of vertex normals that are contained in this mesh. |
|
This is the same as numVertexNormals() with the exception that the transformation matrix is not considered. |
|
Returns the number of vertices that are contained in this mesh. |
|
|
Offsets the surface by the coords specified by 'offsetPoint'. |
Optimizes the mesh by removing all duplicate and unreferenced vertices, vertex normals, and texture coordinates. |
|
Flips the front and the back of parts of the surface as required to create a surface that is oriented. |
|
Removes this mesh's degenerate triangle parts. |
|
|
Removes the measure with name 'measureName' if supplied, or the default measure, if there is one. |
|
This method has 4 modes: |
Removes this mesh's transformation matrix. |
|
|
Renames the measure specified by 'oldMeasureName' to the new name, specified by 'newMeasureName'. |
Flips the surface such that the front and back of the surface are switched. |
|
Removes all vertices, texture coordinates, normals, and mesh parts. |
|
This call assumes that the mesh has been triangulated. |
|
This reverses the order of the surface's points. |
|
|
Rotates this surface about the z-axis by the specified angle, in degrees. |
|
Scale the feature by the given amounts. |
This method associates an appearance within the Library with this surface. |
|
setEdgeVisibilityFlagsToLastPart(edgeVisibilityFlags), |
|
|
Sets the geometry's label 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), |
|
|
This method checks whether the side specified by 'front' exists. |
- class FMEMesh
FME Mesh Class
Create an instance of a Mesh geometry object.
init()
Default
FMEMeshconstructor.- Return type:
- Returns:
An instance of a Mesh geometry object.
init(mesh)
Create a copy of the passed in Mesh geometry object.
- Parameters:
mesh (FMEMesh) – The Mesh geometry object to create a copy of.
- Return type:
- Returns:
An instance of a Mesh geometry object.
- __init__(*args, **kwargs)
- addMeshPart(appearanceReference, vertexIndices, vertexNormalIndices, textureCoordinateIndices)
This routine adds a new mesh part to the mesh. The ‘vertexNormalIndices’ and ‘textureCoordinateIndices’ may be passed in as
Noneif the user does not want to specify vertex normals or texture coordinates for the mesh part. The first indices of the mesh part should match the respective last indices, indicating a closed face. If this is not the case, the mesh part will be closed by the method.- Parameters:
appearanceReference (int) – Should refer to a valid appearance in the shared object library, but no checking is done during this call. The appearance reference of 0 implies that this part will inherit the appearance reference of the mesh.
vertexIndices (list[int]) – Should refer to valid vertices in the vertex list of the mesh, but no validation is done by the method.
vertexNormalIndices (list[int] or None) – Should refer to valid vertex normals stored in the mesh.
textureCoordinateIndices (list[int] or None) – Should refer to valid texture coordinates of the mesh.
- Return type:
- Returns:
Boolean indicating whether or not the addition was successful.
- addMeshPartExtended(hasAFront, hasABack, frontAppRef, backAppRef, vertexIndices, vertexNormalIndices, frontTextCoordIndices, backTextCoordIndices)
This routine extends the functionality of
addMeshPart(), allowing double-sided mesh parts to be added. When both ‘hasAFront’ and ‘hasABack’ areTrue, a double sided part will be added. If one of these parameters isFalse, the corresponding appearance reference and texture coordinates will not be ignore.- Parameters:
hasAFront (bool) – Boolean indicating whether or not the mesh has a front.
hasABack (bool) – Boolean indicating whether or not the mesh has a back.
frontAppRef (int) – Appearance reference for the front of the Mesh. Should refer to a valid appearance in the shared object library, but no checking is done during this call. The appearance reference of 0 implies that this part will inherit the appearance reference of the mesh. If ‘hasAFront’ is
Falsethe value of this parameter is not important, but it must be a valid int.backAppRef (int) – Appearance reference for the back of the Mesh. Should refer to a valid appearance in the shared object library, but no checking is done during this call. The appearance reference of 0 implies that this part will inherit the appearance reference of the mesh. If ‘hasAback’ is
Falsethe value of this parameter is not important, but it must be a valid int.vertexIndices (list of int) – Should refer to valid vertices in the vertex list of the mesh, but no validation is done by the method.
vertexNormalIndices (list[int] or None) – Should refer to valid vertex normals stored in the mesh.
frontTextCoordIndices (list[int] or None) – Should refer to valid texture coordinates of the mesh.
backTextCoordIndices (list[int] or None) – Should refer to valid texture coordinates of the mesh.
- Return type:
- Returns:
Boolean indicating whether or not the addition was successful.
- appendMesh(otherMesh)
Appends a mesh passed in to the mesh, by appending the vertices, vertex normals and texture coordinates and then by appending mesh parts with updated indices.
- Parameters:
otherMesh (FMEMesh) – Another mesh to append to this mesh.
- Return type:
None
- appendTextureCoordinate(u, v, w, q)
Appends the texture coordinate to the end of the texture coordinate list. If there are already texture coordinates and a coordinate is supplied for a component that doesn’t exist, it will be created and back filled with
math.nan. Parameters set tomath.nanwill be ignored.
- appendTextureCoordinates(coords)
Appends the texture coordinates to the end of the texture coordinate list. If there are already texture coordinates stored, the components that previously returned
FalsetohasTextureCoordinates[U|V|W|Q]will be back filled with 0. Parameters set toNonewill be ignored.
- appendVertex(x, y, z)
Appends the point to the end of the vertex list. This method will assume that passed vertices are in local coordinates (i.e. the transformation matrix will be applied to these vertices).
- appendVertexColored(x, y, z, r, g, b)
Appends the point to the end of the vertex list using color information provided. This method will assume that passed vertices are in local coordinates (i.e. the transformation matrix will be applied to these vertices).
- Parameters:
- Return type:
None
- appendVertexNormal(x, y, z)
Appends the point to the end of the vertex normal list.
- appendVertexNormals(points)
Appends the vertex normals to the end of the vertex normal list.
- appendVertices(points)
Appends the vertices to the end of the vertex list. This method will assume that passed vertices are in local coordinates (i.e. the transformation matrix will be applied to these vertices).
- appendVerticesColored(pointsColorsAndHasColor)
Appends the vertices to the end of the vertex list using color information provided.
This method will assume that passed vertices are in local coordinates (i.e. the transformation matrix will be applied to these vertices).
The hasColor flag specifies whether a valid color exists at that vertex index.
- Parameters:
pointsColorsAndHasColor (list[tuple[float, bool]]) – The list of tuple of vertices, colors, and has color flag to be added. A tuple is in the form (x, y, z, r, g, b, hasColor), where vertices are the x, y, z as floats, color components are r, g, b as floats, and the hasColor is a bool.
- Return type:
None
- 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
- copyLabelFromGeometry(sourceGeometry)
Copies the label of the ‘sourceGeometry’ onto this geometry. If ‘sourceGeometry’s label is blank or
None, this geometry’s label will becomeNone. This method replaces the deprecated copyNameFromGeometry() method.- Parameters:
sourceGeometry (FMEGeometry) – The geometry to copy the label 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
- deleteLabel()
Deletes the geometry’s label. If a label existed prior to this call then
Trueis returned; otherwiseFalseis returned. This method replaces the deprecated deleteName() method.- Return type:
- Returns:
Returns a boolean indicating whether or not the label existed before deletion.
- deleteSide(front)
This method deletes the side specified by ‘front’ and indicates whether or not it existed before being deleted.
- 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 surface. The ‘front’ parameter controls whether this query should return the front or the back appearance reference. Both can be fetched independently. If this surface is a regular surface with no geometry instance, a
FMEExceptionwill be thrown.- Parameters:
front (bool) – Boolean indicating whether the appearance reference should be retrieved for the front or back of the surface.
- Return type:
- Returns:
The unique appearance reference for this appearance.
- Raises:
FMEException – An exception is raised if an error occurred or this surface is a regular surface with no geometry instance.
- getAsCompositeSurface()
Returns a composite surface representation of this mesh.
Noneis returned when an error is encountered.- Return type:
FMECompositeSurface or None
- Returns:
Returns a composite surface representation of this mesh or none.
- getAsMultiSurface()
Returns a multi-surface representation of this mesh.
Noneis returned when an error is encountered.- Return type:
FMEMultiSurface or None
- Returns:
Returns a multi-surface representation of this mesh or
None.
- getAsWireFrame()
Returns the wireframe of the surface as a
FMEMultiCurve.Noneis returned if a wireframe cannot be generated.- Return type:
FMEMultiCurve or None
- Returns:
The wireframe of the surface as a
FMEMultiCurve.
- getLabel()
This routine retrieves the ‘label’ of this geometry as a
str. This will returnNoneif it did not have a label associated with it. This method replaces the deprecated getName() method.- Return type:
str or None
- Returns:
The geometry’s label.
- 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.
- getTextureCoordinateAt()
getTextureCoordinateAt(index),
Retrieve the texture coordinate at the specified index. Only components of the texture coordinate that return
TruefromhasTextureCoordinates[U|V|W|Q]will be fetched. A value ofNonemeans that the texture coordinate value doesn’t exist at that index. An error is returned if the index is out of range.- Return type:
- Returns:
The coordinate at the index represented as a (u, v, w, q) tuple or none.
- Raises:
FMEException – An exception is raised if an error occurred.
- getTextureCoordinates()
Retrieves the texture coordinate list with texture coordinates in the same index position as referenced by the faces. Only components where
hasTextureCoordinates[U|V|W|Q]is true will be fetched.- Return type:
- Returns:
The list of coordinates represented as (u, v, w, q) tuples.
- Raises:
FMEException – An exception is raised if an error occurred.
- 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.
Noneis 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
Trueif ‘traitName’ maps to a null trait value on the geometry. Otherwise it isFalse. The second boolean isTrueif ‘traitName’ maps to a no value on the geometry. Otherwise it isFalse. If the trait is absent,FME_ATTR_UNDEFINEDis 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_UNDEFINEDwill 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 mesh’s transformation matrix. If the mesh 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 ].
- getVertexAt(index)
Retrieve the vertex, in global coordinates (i.e., the transformation matrix is applied, if it exists), at the specified index. An FMEException is raised if the index is out of range.
- Return type:
- Returns:
The vertex at the index represented as a (x, y, z) tuple.
- Raises:
FMEException – An exception is raised if an error occurred.
- getVertexColorAt(index)
Retrieves the vertex color at the specified index. Raises an FMEException when a valid color does not exist at the specified index, the index is out of range, or the mesh does not contain vertex colors.
- “raise FMEException: An exception is raised if there is an error at getting
the vertex color.
- getVertexNormalAt(index)
Retrieve the vertex normal, in global coordinates (i.e., the transformation matrix is applied, if it exists), at the specified index. An FMEException is raised if the index is out of range.
- Return type:
- Returns:
The vertex at the index represented as a (x, y, z) tuple.
- Raises:
FMEException – An exception is raised if an error occurred.
- getVertexNormals()
Retrieves the vertex normal list with vertex normals, in global coordinates (i.e., the transformation matrix is applied, if it exists), in the same index position as referenced by the faces.
- Return type:
- Returns:
The list of vertex normals represented as (x, y, z) tuples.
- Raises:
FMEException – An exception is raised if an error occurred.
- getVertexNormalsInLocalCoordinates()
This is the same as
getVertexNormals()with the exception that the transformation matrix is not applied.- Return type:
- Returns:
The list of vertex normals represented as (x, y, z) tuples.
- Raises:
FMEException – An exception is raised if an error occurred.
- getVertices()
Retrieves the vertex list with vertices, in global coordinates (i.e., the transformation matrix is applied, if it exists), in the same index position as referenced by the faces.
- Return type:
- Returns:
The list of vertices represented as (x, y, z) tuples.
- Raises:
FMEException – An exception is raised if an error occurred.
- getVerticesInLocalCoordinates()
This is the same as
getVertices()with the exception that the transformation matrix is not applied.- Return type:
- Returns:
The list of vertices represented as (x, y, z) tuples.
- Raises:
FMEException – An exception is raised if an error occurred.
- hasColorAtVertex(index)
This method determines if there is color at a vertex.
- hasLabel()
Returns whether or not the geometry has a label. This method replaces the deprecated hasName() method.
- hasMeasures()
Check if this geometry or any sub part of this geometry has measures.
- hasTextureCoordinatesQ()
Returns
Trueif the texture coordinates stored have the specified component. ReturnsFalseif no texture coordinates are stored or the specified component of the texture coordinates is not valid for this mesh.
- hasTextureCoordinatesU()
Returns
Trueif the texture coordinates stored have the specified component. ReturnsFalseif no texture coordinates are stored or the specified component of the texture coordinates is not valid for this mesh.
- hasTextureCoordinatesV()
Returns
Trueif the texture coordinates stored have the specified component. ReturnsFalseif no texture coordinates are stored or the specified component of the texture coordinates is not valid for this mesh.
- hasTextureCoordinatesW()
Returns
Trueif the texture coordinates stored have the specified component. ReturnsFalseif no texture coordinates are stored or the specified component of the texture coordinates is not valid for this mesh.
- hasTransformationMatrix()
This method determines if the mesh has a transformation matrix or not.
- is3D()
Returns whether or not the geometry is 3D.
- Return type:
- Returns:
Returns
Trueif the geometry is 3D andFalseotherwise. ForFMENull, this method will always returnTrue. ForFMEAggregate,FMEMultiPoint,FMEMultiArea,FMEMultiTextandFMEMultiCurve, this method will returnTrueif any one of the sub-parts 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 multi-part collection.
- isInPlane(tolerance, normalVector, valD, recalculateD)
Works similarly to
isPlanar(), but checks planarity with respect to given normal or given plane (if plane equation D is specified - see below).If given normal is the zero vector, the normal used to check the planarity is computed using Newell’s method as in
isPlanar(). valD is a reference to a value of D in the plane equation AX + BY + CZ = D. It can be used to make sure that multiple pieces lie in the same plane. If ‘recalculateD’ is set toFalse, the passed in value of D will be used in the calculation. If ‘recalcualteD’ is set toTrue, the passed in value is ignored and is instead automatically calculated (and returned in the second position of the returned tuple). A useful calling pattern for ensuring co-planarity is to get valD computed on the first call to the function setting ‘recalculateD’ toTrue, and then use this value for future calls with ‘recalculateD’ toFalse.- Parameters:
- Return type:
- Returns:
A tuple containing a boolean, tuple, and float representing: 1) Whether or not the surface is in plane; 2) The normal vector returned; and 3) The value ‘D’. Note: If recalculateD is
False, the tuple returned will only contain the boolean and vector tuple (i.e. ‘valD’ is not returned).
- isOriented()
A face with a donut area will not be oriented if the normal of any inner boundary has the same direction as the normal of the outer boundary. Meshes and composite surfaces will return
Falseif they have two parts that share an edge and those two parts are not consistently oriented with respect to each other. If the surface is improperly noded, the behaviour of this function is undefined.
- isPlanar(tolerance)
Returns
Trueif this is planar within the given tolerance, andFalseotherwise.The planarity condition is computed by the following algorithm. The normal vector <A, B, C> is determined by the vertices of this surface using Newell’s method. For the first point (x’, y’, z’) of this surface, we compute D’ = Ax’ + By’ + Cz’. Then, this surface is planar if and only if every subsequent point (x, y, z) of this surface gives a D = Ax + By + Cz, that is within the tolerance amount of D’. That is, | D - D’ | <= tolerance.
If the specified tolerance is negative, then this method always returns
True.
- maxEdgeNumber()
Returns the maximum number of edges the mesh can contain.
- Return type:
- Returns:
Returns the maximum number of edges.
- measureExists(measureName)
Returns
Trueif the specified measure exists andFalseotherwise. If the ‘measureName’ parameter is not specified then the default measure is checked.
- numParts()
This returns the number of faces that are contained in this simple surface.
- Return type:
- Returns:
The number of faces in the simple surface.
- numTextureCoordinates()
Returns the number of texture coordinates that are contained in this mesh.
- Return type:
- Returns:
Returns the number of texture coordinates that are contained in this mesh.
- numVertexColors()
Returns the total number of vertex colors, including invalid ones. This will be either 0, if the mesh does not contain vertex colors, or the same as the number of vertices.
- Return type:
- Returns:
Returns the number of vertex colors.
- numVertexNormals()
Returns the number of vertex normals that are contained in this mesh.
- Return type:
- Returns:
Returns the number of vertex normals in this mesh.
- numVertexNormalsInLocalCoordinates()
This is the same as numVertexNormals() with the exception that the transformation matrix is not considered. If the transformation matrix is not invertible, this will return the number of unmodified normals, numVertexNormals() will return 0 because the normals will be removed if a non-invertible matrix is applied.
- Return type:
- Returns:
Returns the number of vertex normals in local coordinates for this mesh.
- numVertices()
Returns the number of vertices that are contained in this mesh.
- Return type:
- Returns:
Returns the number of vertices in this mesh.
- offset(offsetPoint)
Offsets the surface by the coords specified by ‘offsetPoint’.
- Parameters:
offsetPoint (FMEPoint) – The
FMEPointto offset the surface by.- Return type:
None
- Raises:
FMEException – An exception is raised if an error occurred.
- optimizeVertexPool()
Optimizes the mesh by removing all duplicate and unreferenced vertices, vertex normals, and texture coordinates. This will modify the underlying vertex pools and update the mesh part indices. This is a potentially expensive operation and should not be called unless necessary.
- Return type:
None
- orient()
Flips the front and the back of parts of the surface as required to create a surface that is oriented. Refer to
isOriented()for the specification of what it means to be an oriented surface. If the surface is improperly noded or non-orientable, the behaviour of this function is undefined. All measures are changed as needed, including the vertex normal measures. Note: The vertex normals are not flipped (scaled by -1).- Return type:
None
- removeDegenerateTriangleMeshParts()
Removes this mesh’s degenerate triangle parts.
- 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_RecurseAllRemove some traits at all levels: regex ==
kFME_RecurseSome<string>
For example, specifying regex == NULL for a multi-surface will remove all traits at the root level of the multi-surface, 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 mesh’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 surface such that the front and back of the surface are switched. All measures are changed as needed, including the vertex normal measures. Note: The vertex normals are not flipped (scaled by -1). Refer to
reverse()if the vertex normals need to be flipped. Note:FMETriangleStriphave a method calledisFlipped()that is to be used in conjunction with the geometry to determine which side is the front. WhenisFlipped()returnsTrue, the front is actually the opposite side of what the coordinates of the first triangle in the strip indicate.- Return type:
None
- resetGeometry()
Removes all vertices, texture coordinates, normals, and mesh parts.
- Return type:
None
- resolvePartDefaults()
This call assumes that the mesh has been triangulated. It will remove any mesh parts that do not have three edges and will also remove triangles with repeated vertex indices. It will return true if any parts are removed by the call. This method assumes that duplicate indices have already been removed from the mesh.
- reverse()
This reverses the order of the surface’s points.
- Return type:
None
- rotate2D(center, angle)
Rotates this surface about the z-axis by the specified angle, in degrees. The rotation is performed relative to the center specified. A positive angle corresponds to a counter-clockwise rotation, when looking down onto the XY-plane.
- 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 surface. 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
FMESurfacelevel, 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 surfaces, geometry instances that reference geometries containing surfaces, or as surfaces or multi-surfaces.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:
- 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.
- setEdgeVisibilityFlagsToLastPart()
setEdgeVisibilityFlagsToLastPart(edgeVisibilityFlags),
This routine sets the edge visibility flags to the last mesh part that was added. It is intended to be called directly after addMeshPart(), typically.
The size of the list of flags must be exactly one fewer than the number of vertices on the last part of the mesh.
Passing in None will remove all edge visibility flags from the last mesh part.
- Parameters:
edgeVisibilityFlags (list[bool]) – The list of edge visibility flags.
- Return type:
None
- Raises:
FMEException – An exception is raised if an error occurred.
- setLabel(name)
Sets the geometry’s label with a
str. By supplying a blank label as input, this method will act asdeleteLabel(). This method replaces the deprecated setName() method.- Parameters:
name (str) – The geometry’s new label.
- 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 mesh’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.