CoordinateInputResult

Canonical path: NemAll_Python_IFW_Input.CoordinateInputResult

Data class containing result of a successful point input

Methods:

• GetIdentPntType –

  Get the type of the identification point

• GetPoint –

  Get the 3D point identified during a point input in world coordinates

• IsIdentElement –

  Check for element identification

• IsIdentPntType –

  Check for existing identification point

• IsIdentPoinIntersectionPoint –

  Check for intersection identification point

• IsIdentPointArcIntersection –

  Check for a arc intersection identification point

• IsIdentPointCenter –

  Check for center identification point

• IsIdentPointCenterElement –

  Check for center element identification point

• IsIdentPointDivision –

  Check for a division identification point

• IsIdentPointDockingPoint –

  Check for docking point

• IsIdentPointElement –

  Check for element identification point

• IsIdentPointEndpoint –

  Check for end point

• IsIdentPointOffset –

  Check for offset identification point

• IsIdentPointOrthogonal –

  Check for orthogonal identification point

• IsIdentPointPerpendicular –

  Check for perpendicular identification point

• IsIdentPointQuadrantPoint –

  Check for quadrant identification point

• IsIdentPointTrackElement –

  Check, whether the identification point is a track element point

• IsIdentPointTrackElementFree –

  Check, whether the identification point is a free track element point

• IsIdentPointTrackHelpElement –

  Check, whether the identification point is a track element or help element point

• IsIdentPointTrackIntersection –

  Check, whether the identification point is a track intersection point

• IsIdentPointTrackParallel –

  Check, whether the identification point is a track parallel point

• IsInputPointError –

  Get the error state of the input point

• __eq__ –

  Assign operator

• __init__ –

  Overloaded function. See individual overloads.

• __ne__ –

  Assign operator

GetIdentPntType

GetIdentPntType() -> object

Get the type of the identification point

Returns:

• object –

  Type of the identification point

GetPoint

GetPoint() -> Point3D

Get the 3D point identified during a point input in world coordinates

Returns:

• Point3D –

  Identified point

IsIdentElement

IsIdentElement() -> bool

Check for element identification

Returns:

• bool –

  Identification of an element

IsIdentPntType

IsIdentPntType() -> bool

Check for existing identification point

Returns:

• bool –

  Identification exists: true/false

IsIdentPoinIntersectionPoint

IsIdentPoinIntersectionPoint() -> bool

Check for intersection identification point

Returns:

• bool –

  Identification point is an intersection point

IsIdentPointArcIntersection

IsIdentPointArcIntersection() -> bool

Check for a arc intersection identification point

Returns:

• bool –

  Identification point is an arc intersection point

IsIdentPointCenter

IsIdentPointCenter() -> bool

Check for center identification point

Returns:

• bool –

  Identification point is center point

IsIdentPointCenterElement

IsIdentPointCenterElement() -> bool

Check for center element identification point

Returns:

• bool –

  Identification point is center element point

IsIdentPointDivision

IsIdentPointDivision() -> bool

Check for a division identification point

Returns:

• bool –

  Identification point is a division point

IsIdentPointDockingPoint

IsIdentPointDockingPoint() -> bool

Check for docking point

Returns:

• bool –

  Identification point is docking point: true/false

IsIdentPointElement

IsIdentPointElement() -> bool

Check for element identification point

Returns:

• bool –

  Identification point is element point

IsIdentPointEndpoint

IsIdentPointEndpoint() -> bool

Check for end point

Returns:

• bool –

  Identification point is end point: true/false

IsIdentPointOffset

IsIdentPointOffset() -> bool

Check for offset identification point

Returns:

• bool –

  Identification point is offset point: true/false

IsIdentPointOrthogonal

IsIdentPointOrthogonal() -> bool

Check for orthogonal identification point

Returns:

• bool –

  Identification point is an orthogonal point

IsIdentPointPerpendicular

IsIdentPointPerpendicular() -> bool

Check for perpendicular identification point

Returns:

• bool –

  Identification point is an perpendicular point

IsIdentPointQuadrantPoint

IsIdentPointQuadrantPoint() -> bool

Check for quadrant identification point

Returns:

• bool –

  Identification point is quadrant point of a circle: true/false

IsIdentPointTrackElement

IsIdentPointTrackElement() -> bool

Check, whether the identification point is a track element point

Returns:

• bool –

  Identification point is a track element point: true/false

IsIdentPointTrackElementFree

IsIdentPointTrackElementFree() -> bool

Check, whether the identification point is a free track element point

Returns:

• bool –

  Identification point is a track element point: true/false

IsIdentPointTrackHelpElement

IsIdentPointTrackHelpElement() -> bool

Check, whether the identification point is a track element or help element point

Returns:

• bool –

  Identification point is a track element or help element point: true/false

IsIdentPointTrackIntersection

IsIdentPointTrackIntersection() -> bool

Check, whether the identification point is a track intersection point

Returns:

• bool –

  Identification point is a track intersection point: true/false

IsIdentPointTrackParallel

IsIdentPointTrackParallel() -> bool

Check, whether the identification point is a track parallel point

Returns:

• bool –

  Identification point is a track parallel point: true/false

IsInputPointError

IsInputPointError() -> bool

Get the error state of the input point

In some cases the input point must fulfill a rule, e.g. must be a point at a wall in case of mode IDENT_ARCH_ELEMENTPOINT mode. To check this and continue the input in this case, this member can be used.

Returns:

• bool –

  The input point is not correct: true/false

__eq__

__eq__(pntType: CoordinateInputResult) -> bool

Assign operator

Parameters:

• pntType (CoordinateInputResult) –

  Point type to compare

Returns:

• bool –

  New value

__init__ overloaded

__init__()

Initialize

__init__(inputPnt: Point3D, pntType: object)

Constructor

Parameters:

• inputPnt (Point3D) –

  Input point

• pntType (object) –

  Identification point type

__init__(inputPnt: Point3D, pntType: object, bError: bool)

Constructor

Parameters:

• inputPnt (Point3D) –

  Input point

• pntType (object) –

  Type of the identification point

• bError (bool) –

  The input point is not correct: true/false

__init__(element: CoordinateInputResult)

Copy constructor

Parameters:

• element (CoordinateInputResult) –

  Element to copy

__ne__

__ne__(pntType: CoordinateInputResult) -> bool

Assign operator

Parameters:

• pntType (CoordinateInputResult) –

  Point type to assign

Returns:

• bool –

  New value

Placeholder