gear::xsi::vector Namespace Reference

Data Structures
class	Blade
Functions
def	getDistance
	Get the distance between two positions.
def	getDistance2
	Get the distance between two objects.
def	trigo_opp
def	trigo_adj
def	getDistanceToAxe
def	getOrthocentre
def	getOrthocentreDistances
def	linearlyInterpolate
	Get a vector that is the interpolation of the two input vector.
def	rotateVectorAlongAxis
	Get a vector that is the rotation of first vector along an axis.
def	getPlaneNormal
	Get the normal vector of a plane (Defined by 3 positions).
def	getPlaneBiNormal
	Get the binormal vector of a plane (Defined by 3 positions).
def	getBladeNormal
	Get the normal vector of a blade.
def	getBladeNormalFromXml
def	getBladeBiNormal
	Get the binormal vector of a blade.
def	getBladeBiNormalFromXml
def	getTransposedVector
	Get the transposed vector.
def	getDegreeAngleFromPlane
	Get the transposed vector.
def	drawVector
	Help method to draw a curve that represent a vector.

---

Detailed Description

This file is part of GEAR.

GEAR is free software: you can redistribute it and/or modify
it under the terms of the GNU Lesser General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.

This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU Lesser General Public License for more details.

You should have received a copy of the GNU Lesser General Public License
along with this program.  If not, see <http://www.gnu.org/licenses/lgpl.html>.

Author:     Jeremie Passerin      geerem@hotmail.com
Company:    Studio Nest (TM)
Date:       2010 / 11 / 15

Author:

Jeremie Passerin

---

Function Documentation

def gear::xsi::vector::getDistance	(		v0,
			v1
	)

Get the distance between two positions.

Parameters:

	v0	SIVector3 - First position.
	v1	SIVector3 - Second position.

Returns:

Double - The distance.

def gear::xsi::vector::getDistance2	(		obj0,
			obj1
	)

Get the distance between two objects.

Parameters:

	obj0	X3DObject - First object.
	obj1	X3DObject - Second object.

Returns:

Double - The distance.

def gear::xsi::vector::linearlyInterpolate	(		v0,
			v1,
			blend = .5
	)

Get a vector that is the interpolation of the two input vector.

This method is not limitied to a 0-1

Parameters:

	v0	SIVector3 - First position.
	v1	SIVector3 - Second position.
	blend	Double - Blend between the two vectors. (0 return the first vector, 1 return the second vector)

Returns:

SIVector3 - The interpolated vector.

def gear::xsi::vector::rotateVectorAlongAxis	(		v,
			axis,
			a = 0
	)

Get a vector that is the rotation of first vector along an axis.

Angle must be in radians.

Parameters:

	v	SIVector3 - Vector to transform.
	axis	SIVector3 - Vector use as axes.
	a	Double - Angle in radians.

Returns:

SIVector3 - The newly created vector.

def gear::xsi::vector::getPlaneNormal	(		v0,
			v1,
			v2
	)

Get the normal vector of a plane (Defined by 3 positions).

Parameters:

	v0	SIVector3 - First position on the plane.
	v1	SIVector3 - Second position on the plane.
	v2	SIVector3 - Third position on the plane.

Returns:

SIVector3 - The normal.

def gear::xsi::vector::getPlaneBiNormal	(		v0,
			v1,
			v2
	)

Get the binormal vector of a plane (Defined by 3 positions).

Parameters:

	v0	SIVector3 - First position on the plane.
	v1	SIVector3 - Second position on the plane.
	v2	SIVector3 - Third position on the plane.

Returns:

SIVector3 - The binormal.

def gear::xsi::vector::getBladeNormal

(

blade

)

Get the normal vector of a blade.

A Blade is a 3 points curve that define a plane.

Parameters:

blade

NurbCurve.

Returns:

SIVector3 - The normal.

def gear::xsi::vector::getBladeBiNormal

(

blade

)

Get the binormal vector of a blade.

A Blade is a 3 points curve that define a plane.

Parameters:

blade

NurbCurve.

Returns:

SIVector3 - The binormal.

def gear::xsi::vector::getTransposedVector	(		v,
			position0,
			position1,
			inverse = False
	)

Get the transposed vector.

Parameters:

	v	SIVector - vector to transpose.
	position0	SIVector - original position.
	position1	SIVector - new position.
	inverse	Boolean - True to inverse the orientation.

Returns:

SIVector3 - The transposed vector.

def gear::xsi::vector::getDegreeAngleFromPlane	(		positions0,
			positions1
	)

Get the transposed vector.

Parameters:

	positions0	List of SIVector - first plane position.
	positions1	List of SIVector - second plane position.

Returns:

Double - Angle In Degree.

def gear::xsi::vector::drawVector	(		vector,
			name = "vector",
			parent = xsi.ActiveSceneRoot
	)

Help method to draw a curve that represent a vector.

Parameters:

	vector	SIVector - vector to draw.
	name	String - name of the vector.
	parent	XSI3DObject - parent object. (Used to move a vector at the position of an object).

Returns:

NUrbCurve - The curve that represent the vector.