Dir

Defines a direction object. More...

Public Member Functions
	angle (self, vec_in)
	Returns the interior of two vectors return the angle is in radians.
	cross (self, vec2)
	Returns the cross product of this X vec2 :rtype: :py:class:Dir
	dir_print (self)
	Print the output.
	distance (self, vec_in)
	get the distance between two points
	dot (self, vec2)
	Returns the dot product.
	get_xyz (self)
	Get an array of the vector.
	length (self)
	Returns the length.
	normalize (self)
	Normalize 'this' vector :rtype: void.
	orthogonal_vectors (self)
	Finds 2 (arbitrary) vectors that are orthogonal to this one.
	set (self, x, y, z)
	Set the xyz values of the vector.
	set_x (self, x_in)
	Set the x location of the point.
	set_y (self, y_in)
	Set the y location of the point.
	set_z (self, z_in)
	Set the z location of the point.
	x (self)
	Get the x location of the point.
	y (self)
	Get the y location of the point.
	z (self)
	Get the z location of the point.

Properties
	xVal = property(_cubit3.Dir_xVal_get, _cubit3.Dir_xVal_set)
	yVal = property(_cubit3.Dir_yVal_get, _cubit3.Dir_yVal_set)
	zVal = property(_cubit3.Dir_zVal_get, _cubit3.Dir_zVal_set)

Detailed Description

Defines a direction object.

Member Function Documentation

angle()

angle	(		self,
			vec_in )

Returns the interior of two vectors return the angle is in radians.

cross()

cross	(		self,
			vec2 )

Returns the cross product of this X vec2 :rtype: :py:class:Dir

Returns

cross product

dir_print()

dir_print

(

self

)

Print the output.

distance()

distance	(		self,
			vec_in )

get the distance between two points

dot()

dot	(		self,
			vec2 )

Returns the dot product.

get_xyz()

get_xyz

(

self

)

Get an array of the vector.

length()

length

(

self

)

Returns the length.

normalize()

normalize

(

self

)

Normalize 'this' vector :rtype: void.

Returns

void

orthogonal_vectors()

orthogonal_vectors

(

self

)

Finds 2 (arbitrary) vectors that are orthogonal to this one.

set()

set	(		self,
			x,
			y,
			z )

Set the xyz values of the vector.

:rtype: void

Returns

void

set_x()

set_x	(		self,
			x_in )

Set the x location of the point.

:type x_in: float

Parameters

x_in	the new x value

set_y()

set_y	(		self,
			y_in )

Set the y location of the point.

:type y_in: float

Parameters

y_in	the new y value

set_z()

set_z	(		self,
			z_in )

Set the z location of the point.

:type z_in: float

Parameters

z_in	the new z value

x()

x

(

self

)

Get the x location of the point.

:rtype: float

Returns

x value

See y(), z()

y()

y

(

self

)

Get the y location of the point.

:rtype: float

Returns

y value

See x(), z()

z()

z

(

self

)

Get the z location of the point.

:rtype: float

Returns

z value

See y(), x()

Property Documentation

xVal

xVal = property(_cubit3.Dir_xVal_get, _cubit3.Dir_xVal_set)

static

yVal

yVal = property(_cubit3.Dir_yVal_get, _cubit3.Dir_yVal_set)

static

zVal

zVal = property(_cubit3.Dir_zVal_get, _cubit3.Dir_zVal_set)

static