vector3¶

class samson.DataModel.Type.vector3(*args, **kwargs)¶

Bases: pybind11_builtins.pybind11_object

This class represents physical vectors.

SAMSON API: sbdtypephysicalvector3

Overloaded function.

  1. __init__(self: samson.DataModel.Type.vector3) -> None

Constructs the zero-physical vector [ 0 0 0 ]

  1. __init__(self: samson.DataModel.Type.vector3, x: samson.DataModel.Quantity.unitsSI) -> None

Constructs the physical vector [ x x x ]

  1. __init__(self: samson.DataModel.Type.vector3, x: samson.DataModel.Quantity.unitsSI, y: samson.DataModel.Quantity.unitsSI, z: samson.DataModel.Quantity.unitsSI) -> None

Constructs the physical vector [ x y z ]

  1. __init__(self: samson.DataModel.Type.vector3, u: List[samson.DataModel.Quantity.unitsSI]) -> None

Constructs the physical vector [ u[0] u[1] u[2] ]

  1. __init__(self: samson.DataModel.Type.vector3, x: float) -> None

Constructs the dimensionless physical vector [ x x x ]

  1. __init__(self: samson.DataModel.Type.vector3, x: float, y: float, z: float) -> None

Constructs the dimensionless physical vector [ x y z ]

  1. __init__(self: samson.DataModel.Type.vector3, vec3: List[float]) -> None

Constructs the dimensionless physical vector [ vec3[0] vec3[1] vec3[2] ]

__add__(self: samson.DataModel.Type.vector3, arg0: samson.DataModel.Type.vector3) → samson.DataModel.Type.vector3¶
__eq__(self: samson.DataModel.Type.vector3, arg0: samson.DataModel.Type.vector3) → bool¶
__ge__(self: samson.DataModel.Type.vector3, arg0: samson.DataModel.Type.vector3) → bool¶
__gt__(self: samson.DataModel.Type.vector3, arg0: samson.DataModel.Type.vector3) → bool¶
__iadd__(self: samson.DataModel.Type.vector3, arg0: samson.DataModel.Type.vector3) → samson.DataModel.Type.vector3¶
__imul__(*args, **kwargs)¶

Overloaded function.

  1. __imul__(self: samson.DataModel.Type.vector3, arg0: samson.DataModel.Quantity.unitsSI) -> samson.DataModel.Type.vector3
  2. __imul__(self: samson.DataModel.Type.vector3, arg0: float) -> samson.DataModel.Type.vector3
__isub__(self: samson.DataModel.Type.vector3, arg0: samson.DataModel.Type.vector3) → samson.DataModel.Type.vector3¶
__itruediv__(*args, **kwargs)¶

Overloaded function.

  1. __itruediv__(self: samson.DataModel.Type.vector3, arg0: samson.DataModel.Quantity.unitsSI) -> samson.DataModel.Type.vector3
  2. __itruediv__(self: samson.DataModel.Type.vector3, arg0: float) -> samson.DataModel.Type.vector3
__le__(self: samson.DataModel.Type.vector3, arg0: samson.DataModel.Type.vector3) → bool¶
__lt__(self: samson.DataModel.Type.vector3, arg0: samson.DataModel.Type.vector3) → bool¶
__mul__(*args, **kwargs)¶

Overloaded function.

  1. __mul__(self: samson.DataModel.Type.vector3, arg0: samson.DataModel.Type.vector3) -> samson.DataModel.Type.vector3
  2. __mul__(self: samson.DataModel.Type.vector3, arg0: samson.DataModel.Quantity.unitsSI) -> samson.DataModel.Type.vector3
  3. __mul__(self: samson.DataModel.Type.vector3, arg0: float) -> samson.DataModel.Type.vector3
__ne__(self: samson.DataModel.Type.vector3, arg0: samson.DataModel.Type.vector3) → bool¶
__neg__(self: samson.DataModel.Type.vector3) → samson.DataModel.Type.vector3¶
__rmul__(*args, **kwargs)¶

Overloaded function.

  1. __rmul__(self: samson.DataModel.Type.vector3, arg0: samson.DataModel.Quantity.unitsSI) -> samson.DataModel.Type.vector3
  2. __rmul__(self: samson.DataModel.Type.vector3, arg0: float) -> samson.DataModel.Type.vector3
__sub__(self: samson.DataModel.Type.vector3, arg0: samson.DataModel.Type.vector3) → samson.DataModel.Type.vector3¶
__truediv__(*args, **kwargs)¶

Overloaded function.

  1. __truediv__(self: samson.DataModel.Type.vector3, arg0: samson.DataModel.Quantity.unitsSI) -> samson.DataModel.Type.vector3
  2. __truediv__(self: samson.DataModel.Type.vector3, arg0: float) -> samson.DataModel.Type.vector3
norm(self: samson.DataModel.Type.vector3) → samson.DataModel.Quantity.unitsSI¶

Returns the norm of this physical vector

norm2(self: samson.DataModel.Type.vector3) → samson.DataModel.Quantity.unitsSI¶

Returns the squared norm of this physical vector

normalize(self: samson.DataModel.Type.vector3) → None¶

Normalizes this dimensionless physical vector

normalizeWithUnits(self: samson.DataModel.Type.vector3) → None¶

Normalizes this physical vector while preserving units

normalizedVersion(self: samson.DataModel.Type.vector3) → samson.DataModel.Type.vector3¶

Returns the dimensionless normalized version of this physical vector

normalizedVersionWithUnits(self: samson.DataModel.Type.vector3) → samson.DataModel.Type.vector3¶

Returns the normalized version of this physical vector, but with preserved units

setZero(self: samson.DataModel.Type.vector3) → None¶

Sets all components to zero

str(self: samson.DataModel.Type.vector3, fullName: bool = False) → str¶

Converts the physical vector to a string (with a full unit name when fullName is true)

swap(self: samson.DataModel.Type.vector3, i: int, j: int) → None¶

Swaps components i and j of this physical vector

value¶
x¶

x component

y¶

y component

z¶

z component