eVision Python API
Loading...
Searching...
No Matches
eVision.Easy3D.E3DBox Class Reference

A 3D box, used as bounding volume for eVision.Easy3D.E3DObject class. More...

Public Member Functions

None __init__ (self)
 Constructs an eVision.Easy3D.E3DBox.
None __init__ (self, float xSize, float ySize, float zSize)
 Constructs an eVision.Easy3D.E3DBox.
None __init__ (self, eVision.Easy3D.E3DOrthonormalAxisSystem axes, float xSize, float ySize, float zSize)
 Constructs an eVision.Easy3D.E3DBox.
None __init__ (self, eVision.Easy3D.E3DBox other)
 Constructs an eVision.Easy3D.E3DBox.
None __init__ (self, eVision.Easy3D.E3DPoint center, float xSize, float ySize, float zSize)
 Constructs an eVision.Easy3D.E3DBox.
None __init__ (self, eVision.EFloatRange xBounds, eVision.EFloatRange yBounds, eVision.EFloatRange zBounds)
 Constructs an eVision.Easy3D.E3DBox.
None __init__ (self, eVision.Easy3D.E3DPoint center, float roll, float pitch, float yaw, float xSize, float ySize, float zSize)
 Constructs an eVision.Easy3D.E3DBox.
None Load (self, str path)
 Loads the eVision.Easy3D.E3DBox.
None Load (self, eVision.ESerializer|None serializer)
 Loads the eVision.Easy3D.E3DBox.
None Save (self, str path)
 Saves the eVision.Easy3D.E3DBox.
None Save (self, eVision.ESerializer|None serializer)
 Saves the eVision.Easy3D.E3DBox.
eVision.Easy3D.E3DBox Transform (self, eVision.Easy3D.E3DTransformMatrix matrix)
 Transforms the 3D box with the given transformation matrix.
eVision.Easy3D.E3DPoint Center (self)
 3D box center.
 Center (self, eVision.Easy3D.E3DPoint value)
 3D box center.
eVision.Easy3D.E3DPoint XAxis (self)
 X axis of the box.
eVision.Easy3D.E3DPoint YAxis (self)
 Y axis of the box.
eVision.Easy3D.E3DPoint ZAxis (self)
 Z axis of the box.
eVision.Easy3D.E3DOrthonormalAxisSystem Axes (self)
 3D orthonormal axis system of the box.
 Axes (self, eVision.Easy3D.E3DOrthonormalAxisSystem value)
 3D orthonormal axis system of the box.
float XSize (self)
 Size of the 3D box along its X axis .
 XSize (self, float value)
 Size of the 3D box along its X axis .
float YSize (self)
 Size of the 3D box along its Y axis.
 YSize (self, float value)
 Size of the 3D box along its Y axis.
float ZSize (self)
 Size of the 3D box along its Z axis.
 ZSize (self, float value)
 Size of the 3D box along its Z axis.
eVision.EQuadrangle XYQuadrangle (self)
 2D quadrangle of the eVision.Easy3D.E3DBox in the XY plane

Detailed Description

A 3D box, used as bounding volume for eVision.Easy3D.E3DObject class.

A box is defined by a center, 3 axis and 3 extent for the 3 axis. A 3D point (x,y,z) is inside the eVision.Easy3D.E3DBox if ... By default a eVision.Easy3D.E3DBox is an axis aligned unit cube, centered on the origin.

Remarks:

License(s): Easy3D

Constructor & Destructor Documentation

◆ __init__() [1/7]

None eVision.Easy3D.E3DBox.__init__ ( self)

Constructs an eVision.Easy3D.E3DBox.

By default a eVision.Easy3D.E3DBox is an axis aligned unit cube, centered on the origin.

Remarks:

By convention, roll is applied first and yaw last.

◆ __init__() [2/7]

None eVision.Easy3D.E3DBox.__init__ ( self,
float xSize,
float ySize,
float zSize )

Constructs an eVision.Easy3D.E3DBox.

By default a eVision.Easy3D.E3DBox is an axis aligned unit cube, centered on the origin.

Remarks:

By convention, roll is applied first and yaw last.

Parameters
xSizeThe full size of the box along the X axis.
ySizeThe full size of the box along the Y axis.
zSizeThe full size of the box along the Z axis.

◆ __init__() [3/7]

None eVision.Easy3D.E3DBox.__init__ ( self,
eVision.Easy3D.E3DOrthonormalAxisSystem axes,
float xSize,
float ySize,
float zSize )

Constructs an eVision.Easy3D.E3DBox.

By default a eVision.Easy3D.E3DBox is an axis aligned unit cube, centered on the origin.

Remarks:

By convention, roll is applied first and yaw last.

Parameters
axesAxis system.
xSizeThe full size of the box along the X axis.
ySizeThe full size of the box along the Y axis.
zSizeThe full size of the box along the Z axis.

◆ __init__() [4/7]

None eVision.Easy3D.E3DBox.__init__ ( self,
eVision.Easy3D.E3DBox other )

Constructs an eVision.Easy3D.E3DBox.

By default a eVision.Easy3D.E3DBox is an axis aligned unit cube, centered on the origin.

Remarks:

By convention, roll is applied first and yaw last.

Parameters
otherReference to another eVision.Easy3D.E3DBox used for the initialization.

◆ __init__() [5/7]

None eVision.Easy3D.E3DBox.__init__ ( self,
eVision.Easy3D.E3DPoint center,
float xSize,
float ySize,
float zSize )

Constructs an eVision.Easy3D.E3DBox.

By default a eVision.Easy3D.E3DBox is an axis aligned unit cube, centered on the origin.

Remarks:

By convention, roll is applied first and yaw last.

Parameters
centerThe 3D coordinate of the box center.
xSizeThe full size of the box along the X axis.
ySizeThe full size of the box along the Y axis.
zSizeThe full size of the box along the Z axis.

◆ __init__() [6/7]

None eVision.Easy3D.E3DBox.__init__ ( self,
eVision.EFloatRange xBounds,
eVision.EFloatRange yBounds,
eVision.EFloatRange zBounds )

Constructs an eVision.Easy3D.E3DBox.

By default a eVision.Easy3D.E3DBox is an axis aligned unit cube, centered on the origin.

Remarks:

By convention, roll is applied first and yaw last.

Parameters
xBoundsThe bounds of box along the X axis.
yBoundsThe bounds of box along the Y axis.
zBoundsThe bounds of box along the Z axis.

◆ __init__() [7/7]

None eVision.Easy3D.E3DBox.__init__ ( self,
eVision.Easy3D.E3DPoint center,
float roll,
float pitch,
float yaw,
float xSize,
float ySize,
float zSize )

Constructs an eVision.Easy3D.E3DBox.

By default a eVision.Easy3D.E3DBox is an axis aligned unit cube, centered on the origin.

Remarks:

By convention, roll is applied first and yaw last.

Parameters
centerThe 3D coordinate of the box center.
rollRoll (rotation along the X axis) of the box.
pitchPitch (rotation along the Y axis) of the box.
yawYaw (rotation along the Z axis) of the box.
xSizeThe full size of the box along the X axis.
ySizeThe full size of the box along the Y axis.
zSizeThe full size of the box along the Z axis.

Member Function Documentation

◆ Axes() [1/2]

eVision.Easy3D.E3DOrthonormalAxisSystem eVision.Easy3D.E3DBox.Axes ( self)

3D orthonormal axis system of the box.

◆ Axes() [2/2]

eVision.Easy3D.E3DBox.Axes ( self,
eVision.Easy3D.E3DOrthonormalAxisSystem value )

3D orthonormal axis system of the box.

◆ Center() [1/2]

eVision.Easy3D.E3DPoint eVision.Easy3D.E3DBox.Center ( self)

3D box center.

◆ Center() [2/2]

eVision.Easy3D.E3DBox.Center ( self,
eVision.Easy3D.E3DPoint value )

3D box center.

◆ Load() [1/2]

None eVision.Easy3D.E3DBox.Load ( self,
eVision.ESerializer | None serializer )

Loads the eVision.Easy3D.E3DBox.

The given eVision.ESerializer must have been created for reading.

Parameters
serializerThe serializer.

◆ Load() [2/2]

None eVision.Easy3D.E3DBox.Load ( self,
str path )

Loads the eVision.Easy3D.E3DBox.

The given eVision.ESerializer must have been created for reading.

Parameters
pathThe file path.

◆ Save() [1/2]

None eVision.Easy3D.E3DBox.Save ( self,
eVision.ESerializer | None serializer )

Saves the eVision.Easy3D.E3DBox.

The given eVision.ESerializer must have been created for writing.

Parameters
serializerThe serializer.

◆ Save() [2/2]

None eVision.Easy3D.E3DBox.Save ( self,
str path )

Saves the eVision.Easy3D.E3DBox.

The given eVision.ESerializer must have been created for writing.

Parameters
pathThe file path.

◆ Transform()

eVision.Easy3D.E3DBox eVision.Easy3D.E3DBox.Transform ( self,
eVision.Easy3D.E3DTransformMatrix matrix )

Transforms the 3D box with the given transformation matrix.

The transformation matrix must contain a rigid transformation (translation and rotation only) optionally combined with an anisotropic scaling transform if it is applied before and on an axis aligned eVision.Easy3D.E3DBox.

Parameters
matrixThe 3D transformation matrix.

◆ XAxis()

eVision.Easy3D.E3DPoint eVision.Easy3D.E3DBox.XAxis ( self)

X axis of the box.

◆ XSize() [1/2]

float eVision.Easy3D.E3DBox.XSize ( self)

Size of the 3D box along its X axis .

◆ XSize() [2/2]

eVision.Easy3D.E3DBox.XSize ( self,
float value )

Size of the 3D box along its X axis .

◆ XYQuadrangle()

eVision.EQuadrangle eVision.Easy3D.E3DBox.XYQuadrangle ( self)

2D quadrangle of the eVision.Easy3D.E3DBox in the XY plane

◆ YAxis()

eVision.Easy3D.E3DPoint eVision.Easy3D.E3DBox.YAxis ( self)

Y axis of the box.

◆ YSize() [1/2]

float eVision.Easy3D.E3DBox.YSize ( self)

Size of the 3D box along its Y axis.

◆ YSize() [2/2]

eVision.Easy3D.E3DBox.YSize ( self,
float value )

Size of the 3D box along its Y axis.

◆ ZAxis()

eVision.Easy3D.E3DPoint eVision.Easy3D.E3DBox.ZAxis ( self)

Z axis of the box.

◆ ZSize() [1/2]

float eVision.Easy3D.E3DBox.ZSize ( self)

Size of the 3D box along its Z axis.

◆ ZSize() [2/2]

eVision.Easy3D.E3DBox.ZSize ( self,
float value )

Size of the 3D box along its Z axis.