fmeobjects.FMECSGSolidIterator

Inheritance diagram of fmeobjects.FMECSGSolidIterator

FMECSGSolidIterator.getOperator()

This method returns a valid CSG Boolean Operator if isLeaf() returns True.

FMECSGSolidIterator.getPartInLocalCoordinates()

This method returns the same solid as next() but if the CSG solid has a transformation matrix, the matrix is NOT applied to the leaf solid when returned.

FMECSGSolidIterator.isBranch()

This method returns True if the iterator reaches a branch node in the CSG solid tree structure and if next() was called a Stop iteration exception would be thrown.

FMECSGSolidIterator.isLeftLeaf()

This method returns True if the iterator reaches a left leaf node in the CSG solid tree structure.

FMECSGSolidIterator.isRightLeaf()

This method returns True if the iterator reaches a right leaf node in the CSG solid tree structure.

class FMECSGSolidIterator

FME CSG Solid Iterator Class

init()

FMECSGSolidIterator should not be constructed directly. Instead, use the iterator semantics of FMECSGSolid to get an FMECSGSolidIterator which can be used to iterate over its geometries.

__init__(*args, **kwargs)
getOperator()

This method returns a valid CSG Boolean Operator if isLeaf() returns True. This method returns FME_CSG_NONE if isLeaf() returns False.

Return type:

int

Returns:

Returns a valid CSG Boolean Operator.

getPartInLocalCoordinates()

This method returns the same solid as next() but if the CSG solid has a transformation matrix, the matrix is NOT applied to the leaf solid when returned. This method must be called after next().

Return type:

FMESolid or None

Returns:

Returns the solid at the current node in local coordinates.

isBranch()

This method returns True if the iterator reaches a branch node in the CSG solid tree structure and if next() was called a Stop iteration exception would be thrown. This method returns False if the iterator is at a leaf node.

Return type:

bool

Returns:

Returns True if the iterator reaches a branch node and false otherwise.

isLeftLeaf()

This method returns True if the iterator reaches a left leaf node in the CSG solid tree structure. This method returns False if the iterator is at a branch node or a right leaf node in the CSG solid tree structure.

Return type:

bool

Returns:

Returns True if the iterator reaches a left leaf node and false otherwise.

isRightLeaf()

This method returns True if the iterator reaches a right leaf node in the CSG solid tree structure. This method returns False if the iterator is at a branch node or a left leaf node in the CSG solid tree structure.

Return type:

bool

Returns:

Returns True if the iterator reaches a right leaf node and false otherwise.