Module fmeobjects :: Class FMECSGSolidIterator

Class FMECSGSolidIterator

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.

Instance Methods

[hide private]

__init__()
x.__init__(...) initializes x; see help(type(x)) for signature

__iter__(x)
iter(x)

a new object with type S, a subtype of T

__new__(T, S, ...)

int

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

FMESolid or None

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.

bool

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.

bool

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

bool

isRightLeaf()
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.

the next value, or raise StopIteration

next(x)

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()
(Constructor)

x.__init__(...) initializes x; see help(type(x)) for signature

Overrides: object.__init__

new(T, S, ...)

Returns: a new object with type S, a subtype of T
Overrides: object.__new__

getOperator()

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

Returns: int: 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().

Returns: FMESolid or None: 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.

Returns: bool: 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.

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

isRightLeaf()

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.

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

Class FMECSGSolidIterator

__init__() (Constructor)

__new__(T, S, ...)

getOperator()

getPartInLocalCoordinates()

isBranch()

isLeftLeaf()

isRightLeaf()

init()
(Constructor)

new(T, S, ...)