coat.box Class Reference

Public Member Functions
	__init__ (self)
	__init__ (self, sizeX=float, sizeY=float, sizeZ=float)
	__init__ (self, size=vec3)
	__init__ (self, pos=vec3, size=vec3)
	__init__ (self, pos=vec3, size=vec3, fillet=float)
box	axis (self, directionX=vec3)
	set the x-direction
box	axis (self, directionX=vec3, directionY=vec3)
	set the x and y direction
box	axis (self, directionX=vec3, directionY=vec3, directionZ=vec3)
	set the x, y and z direction
box	reset_axis (self)
	reset the x, y and z direction
vec3	axis_x (self)
	get the x-axis
vec3	axis_y (self)
	get the y-axis
vec3	axis_z (self)
	get the z-axis
box	divide (self, nx=int, ny=int, nz=int)
	set the number deviding
box	size (self, _size=vec3)
	set the box size
box	size (self, x=float, y=float, z=float)
	set the box size
vec3	size (self)
	get the box size.
float	fillet_relative (self)
	calculates a fillet relative value (0..1).

Constructor & Destructor Documentation

__init__() [1/5]

coat.box.__init__

(

self

)

__init__() [2/5]

coat.box.__init__	(		self,
			sizeX = float,
			sizeY = float,
			sizeZ = float
	)

__init__() [3/5]

coat.box.__init__	(		self,
			size = vec3
	)

__init__() [4/5]

coat.box.__init__	(		self,
			pos = vec3,
			size = vec3
	)

__init__() [5/5]

coat.box.__init__	(		self,
			pos = vec3,
			size = vec3,
			fillet = float
	)

Member Function Documentation

axis() [1/3]

box coat.box.axis	(		self,
			directionX = vec3
	)

set the x-direction

Parameters

directionX

the x-direction

Returns

box reference

axis() [2/3]

box coat.box.axis	(		self,
			directionX = vec3,
			directionY = vec3
	)

set the x and y direction

Parameters

directionX	the x-direction
directionY	the y-direction

Returns

box reference

axis() [3/3]

box coat.box.axis	(		self,
			directionX = vec3,
			directionY = vec3,
			directionZ = vec3
	)

set the x, y and z direction

Parameters

directionX	the x-direction
directionY	the y-direction
directionZ	the z-direction

Returns

box reference

axis_x()

vec3 coat.box.axis_x

(

self

)

get the x-axis

Returns

vec3 axis

axis_y()

vec3 coat.box.axis_y

(

self

)

get the y-axis

Returns

vec3 axis

axis_z()

vec3 coat.box.axis_z

(

self

)

get the z-axis

Returns

vec3 axis

divide()

box coat.box.divide	(		self,
			nx = int,
			ny = int,
			nz = int
	)

set the number deviding

Parameters

nx	number deviding along the x-axis
ny	number deviding along the y-axis
nz	number deviding along the z-axis

Returns

box reference

fillet_relative()

float coat.box.fillet_relative

(

self

)

calculates a fillet relative value (0..1).

Returns

fillet relative value

reset_axis()

box coat.box.reset_axis

(

self

)

reset the x, y and z direction

Returns

box reference

size() [1/3]

vec3 coat.box.size

(

self

)

get the box size.

Returns

size

size() [2/3]

box coat.box.size	(		self,
			_size = vec3
	)

set the box size

Parameters

_size

size

Returns

box reference

size() [3/3]

box coat.box.size	(		self,
			x = float,
			y = float,
			z = float
	)

set the box size

Parameters

x	size x
y	size y
z	size z

Returns

box reference

---

The documentation for this class was generated from the following file:

• coat.py