Cubit Python API  17.05
Public Member Functions | Properties
Dir

Defines a direction object. More...

Public Member Functions

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

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()

def angle (   self,
  vec_in 
)

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

◆ cross()

def cross (   self,
  vec2 
)

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

Returns
cross product

◆ dir_print()

def dir_print (   self )

Print the output.

◆ distance()

def distance (   self,
  vec_in 
)

get the distance between two points

◆ dot()

def dot (   self,
  vec2 
)

Returns the dot product.

◆ get_xyz()

def get_xyz (   self )

Get an array of the vector.

◆ length()

def length (   self )

Returns the length.

◆ normalize()

def normalize (   self )

Normalize 'this' vector :rtype: void.

Returns
void

◆ orthogonal_vectors()

def orthogonal_vectors (   self )

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

◆ set()

def set (   self,
  x,
  y,
  z 
)

Set the xyz values of the vector.

:rtype: void

Returns
void

◆ set_x()

def 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()

def 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()

def set_z (   self,
  z_in 
)

Set the z location of the point.

:type z_in: float

Parameters
z_in the new z value

◆ x()

def x (   self )

Get the x location of the point.

:rtype: float

Returns
x value
See y(), z()

◆ y()

def y (   self )

Get the y location of the point.

:rtype: float

Returns
y value
See x(), z()

◆ z()

def 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