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.

Properties
	Center = property(_Center__getter, _Center__setter)
	3D box center.
	XAxis = property(_XAxis__getter, None)
	X axis of the box.
	YAxis = property(_YAxis__getter, None)
	Y axis of the box.
	ZAxis = property(_ZAxis__getter, None)
	Z axis of the box.
	Axes = property(_Axes__getter, _Axes__setter)
	3D orthonormal axis system of the box.
	XSize = property(_XSize__getter, _XSize__setter)
	Size of the 3D box along its X axis .
	YSize = property(_YSize__getter, _YSize__setter)
	Size of the 3D box along its Y axis.
	ZSize = property(_ZSize__getter, _ZSize__setter)
	Size of the 3D box along its Z axis.
	XYQuadrangle = property(_XYQuadrangle__getter, None)
	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

xSize	The full size of the box along the X axis.
ySize	The full size of the box along the Y axis.
zSize	The 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

axes	Axis system.
xSize	The full size of the box along the X axis.
ySize	The full size of the box along the Y axis.
zSize	The 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

other

Reference 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

center	The 3D coordinate of the box center.
xSize	The full size of the box along the X axis.
ySize	The full size of the box along the Y axis.
zSize	The 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

xBounds	The bounds of box along the X axis.
yBounds	The bounds of box along the Y axis.
zBounds	The 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

center	The 3D coordinate of the box center.
roll	Roll (rotation along the X axis) of the box.
pitch	Pitch (rotation along the Y axis) of the box.
yaw	Yaw (rotation along the Z axis) of the box.
xSize	The full size of the box along the X axis.
ySize	The full size of the box along the Y axis.
zSize	The full size of the box along the Z axis.

Member Function Documentation

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

serializer

The 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

path	The 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

serializer

The 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

path	The 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

matrix

The 3D transformation matrix.

Property Documentation

Axes

eVision.Easy3D.E3DBox.Axes = property(_Axes__getter, _Axes__setter)

static

3D orthonormal axis system of the box.

Center

eVision.Easy3D.E3DBox.Center = property(_Center__getter, _Center__setter)

static

3D box center.

XAxis

eVision.Easy3D.E3DBox.XAxis = property(_XAxis__getter, None)

static

X axis of the box.

XSize

eVision.Easy3D.E3DBox.XSize = property(_XSize__getter, _XSize__setter)

static

Size of the 3D box along its X axis .

XYQuadrangle

eVision.Easy3D.E3DBox.XYQuadrangle = property(_XYQuadrangle__getter, None)

static

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

YAxis

eVision.Easy3D.E3DBox.YAxis = property(_YAxis__getter, None)

static

Y axis of the box.

YSize

eVision.Easy3D.E3DBox.YSize = property(_YSize__getter, _YSize__setter)

static

Size of the 3D box along its Y axis.

ZAxis

eVision.Easy3D.E3DBox.ZAxis = property(_ZAxis__getter, None)

static

Z axis of the box.

ZSize

eVision.Easy3D.E3DBox.ZSize = property(_ZSize__getter, _ZSize__setter)

static

Size of the 3D box along its Z axis.