adskVector.h File Reference

---

Detailed Description

Vector manipulation functions.

#include <shader.h>
#include "adskShaderSDKNamespaceBegin.h"
#include "adskShaderSDKNamespaceEnd.h"
#include "adskConstants.h"

Include dependency graph for adskVector.h:

This graph shows which files directly or indirectly include this file:

Functions
bool	MAYA_ISVECTORNULL (const miVector &v)
	Determine if vector is NULL vector.
miVector	operator* (const miVector &lhs, const miScalar &rhs)
	Multiplies a vector by a scalar.
miVector	operator* (const miScalar &lhs, const miVector &rhs)
	Multiplies a vector by a scalar.
miVector	operator* (const miVector &lhs, const miVector &rhs)
	Multiplies a vector by a vector (component by component).
miVector	operator/ (const miVector &lhs, const miScalar &rhs)
	Divide a vector by a scalar.
miVector	operator/ (const miVector &lhs, const int &rhs)
	Divide a vector by an integer.
miVector	operator+ (const miVector &lhs, const miVector &rhs)
	Add two vectors together.
miVector	operator- (const miVector &lhs, const miVector &rhs)
	Subtract two vectors.

---

Function Documentation

bool MAYA_ISVECTORNULL

(

const miVector &

v

)

[inline]

Determine if vector is NULL vector.

Parameters:

[in]

v

Vector to test.

Returns:

True if all components of the vector are with MAYA_EPS of zero.

miVector operator*	(	const miVector &	lhs,
		const miVector &	rhs
	)			[inline]

Multiplies a vector by a vector (component by component).

This returns a new vector whose components are the products of the respective components of the operands.

Parameters:

[in]	lhs	The vector to be multiplied.
[in]	rhs	The other vector to be multiplied.

Returns:

The multiplied vector.

miVector operator*	(	const miScalar &	lhs,
		const miVector &	rhs
	)			[inline]

Multiplies a vector by a scalar.

Parameters:

[in]	lhs	The scalar to multiply by.
[in]	rhs	The vector to be multiplied.

Returns:

The multiplied vector.

miVector operator*	(	const miVector &	lhs,
		const miScalar &	rhs
	)			[inline]

Multiplies a vector by a scalar.

Parameters:

[in]	lhs	The vector to be multiplied.
[in]	rhs	The scalar to multiply by.

Returns:

The multiplied vector.

miVector operator+	(	const miVector &	lhs,
		const miVector &	rhs
	)			[inline]

Add two vectors together.

This returns a vector representing the sum of the two operands.

Parameters:

[in]	lhs	One of the vectors to be added.
[in]	rhs	The other vector to be added.

Returns:

The added vector.

miVector operator-	(	const miVector &	lhs,
		const miVector &	rhs
	)			[inline]

Subtract two vectors.

This returns a vector representing the difference of the two operands.

Parameters:

[in]	lhs	The vector to be subtracted from.
[in]	rhs	The vector to subtract.

Returns:

The vector difference.

miVector operator/	(	const miVector &	lhs,
		const int &	rhs
	)			[inline]

Divide a vector by an integer.

This returns a vector whose components have each been divided by an integer.

Parameters:

[in]	lhs	The vector to be divided.
[in]	rhs	The divisor.

Returns:

The divided vector.

miVector operator/	(	const miVector &	lhs,
		const miScalar &	rhs
	)			[inline]

Divide a vector by a scalar.

This returns a vector whose components have each been divided by a scalar.

Parameters:

[in]	lhs	The vector to be divided.
[in]	rhs	The divisor.

Returns:

The divided vector.