AxisPlacement3D

Canonical path: NemAll_Python_Geometry.AxisPlacement3D

Representation class for orthogonal axis placement in 3D space

Placement is given by Origin and 2 direction vectors - local x-axis and local z-axis. y-axis is computed on demand

Methods:

• CalcGlobalPoint –

  Calculate global point from local coordinate system of placement 3D

• CalcLocalPoint –

  Calculate local point in coordinate system of placement 3D

• GetOrigin –

  Get origin

• GetRotationMatrix –

  Get Rotation matrix given by placement 3D

• GetTransformationMatrix –

  Get Transformation matrix given by placement 3D

• GetXDirection –

  Get x-direction

• GetYDirection –

  Get direction of local y-axis

• GetZDirection –

  Get z-direction

• IsValid –

  Check if the placement is valid

• RotateAroundLocalZAxis –

  Rotate the placement around it's Z-axis

• Set –

  Set the placement

• SetOrigin –

  Set origin

• SetXDirection –

  Set x-direction

• SetZDirection –

  Set z-direction

• __eq__ –

  Comparison of axis placements.

• __init__ –

  dummy, is only needed for the creation of the documentation by MkDocs

• __repr__ –

  Convert to string

Attributes:

• Origin (Point3D) –

  Get origin

• XDirection (Vector3D) –

  Get x-direction

• ZDirection (Vector3D) –

  Get z-direction

Origin property writable

Origin: Point3D

Get origin

XDirection property writable

XDirection: Vector3D

Get x-direction

ZDirection property writable

ZDirection: Vector3D

Get z-direction

CalcGlobalPoint

CalcGlobalPoint(point: Point3D) -> Point3D

Calculate global point from local coordinate system of placement 3D

Parameters:

• point (Point3D) –

  local point 3D

Returns:

• Point3D –

  Point3D instance

CalcLocalPoint

CalcLocalPoint(point: Point3D) -> Point3D

Calculate local point in coordinate system of placement 3D

Parameters:

• point (Point3D) –

  global point 3D

Returns:

• Point3D –

  Point3D instance

GetOrigin

GetOrigin() -> Point3D

Get origin

Returns:

• Point3D –

  Origin

GetRotationMatrix

GetRotationMatrix() -> Matrix3D

Get Rotation matrix given by placement 3D

Returns:

• Matrix3D –

  Matrix3D const reference

GetTransformationMatrix

GetTransformationMatrix() -> Matrix3D

Get Transformation matrix given by placement 3D

Returns:

• Matrix3D –

  Matrix3D const reference

GetXDirection

GetXDirection() -> Vector3D

Get x-direction

Returns:

• Vector3D –

  Vector3D const reference

GetYDirection

GetYDirection() -> Vector3D

Get direction of local y-axis

Returns:

• Vector3D –

  Vector3D const reference

GetZDirection

GetZDirection() -> Vector3D

Get z-direction

Returns:

• Vector3D –

  Vector3D const reference

IsValid

IsValid() -> bool

Check if the placement is valid

Returns:

• bool –

  True if it is a valid placement

RotateAroundLocalZAxis

RotateAroundLocalZAxis(angle: Angle)

Rotate the placement around it's Z-axis

Parameters:

• angle (Angle) –

  rotation angle

Set

Set(origin: Point3D, xDir: Vector3D, zDir: Vector3D)

Set the placement

Parameters:

• origin (Point3D) –

  New origin

• xDir (Vector3D) –

  New X-direction

• zDir (Vector3D) –

  New Z-direction

SetOrigin

SetOrigin(origin: Point3D)

Set origin

Parameters:

• origin (Point3D) –

  New origin

SetXDirection

SetXDirection(dir: Vector3D)

Set x-direction

Parameters:

• dir (Vector3D) –

  Vector3D const reference

SetZDirection

SetZDirection(dir: Vector3D)

Set z-direction

Parameters:

• dir (Vector3D) –

  Vector3D const reference

__eq__

__eq__(axis_placement: AxisPlacement3D) -> bool

Comparison of axis placements.

Be careful, this method work without tolerance!

Parameters:

• axis_placement (AxisPlacement3D) –

  axis placement to be compared.

Returns:

• bool –

  True when axis placements are equal, otherwise false.

__init__ overloaded

__init__()

Initialize

__init__(placement: AxisPlacement3D)

Copy constructor.

Parameters:

• placement (AxisPlacement3D) –

  Placement to be copied

__init__(refPoint: Point3D)

Constructor with only reference point

Parameters:

• refPoint (Point3D) –

  reference point

__init__(refPoint: Point3D, xvector: Vector3D, zvector: Vector3D)

Constructor which fully constructs the element.

Parameters:

• refPoint (Point3D) –

  reference point

• xvector (Vector3D) –

  direction vector X

• zvector (Vector3D) –

  direction vector Z

__init__(rotationAxis: Axis3D, rotationStart: Point3D)

Constructor from rotation axis and start point of rotation.

Parameters:

• rotationAxis (Axis3D) –

  rotation axis

• rotationStart (Point3D) –

  starting point of rotation, have not to be on axis

__init__(matrix: Matrix3D)

Constructor from Matrix3D

Parameters:

• matrix (Matrix3D) –

  matrix

__repr__

__repr__() -> str

Convert to string