sack::math::vector Namespace

Vector namespace contains methods for operating on vectors. Vectors are multi-dimensional scalar quantities, often used to represent coordinates and directions in space.

Namespace

sack::math Namespace

Topics

Name	Description
Functions	The following table lists functions in this documentation.
Structs, Records, Enums	The following table lists structs, records, enums in this documentation.
Types	The following table lists types in this documentation.
Variables	The following table lists variables in this documentation.
Macros	The following table lists macros in this documentation.

Functions

	Name	Description
	add	Add two vectors together. (a1,b1,c1) + (a2,b2,c2) = (a1+a2,b1+b2,c1+c2)
	addscaled	Adds a vector scaled by a scalar to another vector, results in a third vector.
	AddTransformCallback	When Move is called on the transform, these callbacks are invoked so user code can get even update for motion.
	Apply	This is function sack::math::vector::Apply.
	ApplyInverse	I know this was a result - unsure how it was implented... void ApplyT (PTRANFORM pt, PTRANSFORM pt1, PTRANSFORM pt2 );
	ApplyInverseR	This is function sack::math::vector::ApplyInverseR.
	ApplyInverseRotation	This is function sack::math::vector::ApplyInverseRotation.
	ApplyInverseRotationT	This is function sack::math::vector::ApplyInverseRotationT.
	ApplyInverseT	This is function sack::math::vector::ApplyInverseT.
	ApplyInverseTranslation	This is function sack::math::vector::ApplyInverseTranslation.
	ApplyInverseTranslationT	This is function sack::math::vector::ApplyInverseTranslationT.
	ApplyR	This is function sack::math::vector::ApplyR.
	ApplyRotation	again note there was a void ApplyInverseT
	ApplyRotationT	This is function sack::math::vector::ApplyRotationT.
	ApplyT	This is function sack::math::vector::ApplyT.
	ApplyTranslation	This is function sack::math::vector::ApplyTranslation.
	ApplyTranslationT	This is function sack::math::vector::ApplyTranslationT.
	ClearTransform	Resets a transform back to initial conitions.
	CosAngle	Returns the cos (cosine) of the angle between two vectors.
	CreateNamedTransform	Allocates and initializes a new transform for the user. if name is NULL, allocates an unnamed transform; otherwise the transform is created in a known namespace that can be browsed.
	CreateTransformMotion	This is function sack::math::vector::CreateTransformMotion.
	crossproduct	This is function sack::math::vector::crossproduct.
	DestroyTransform	This is function sack::math::vector::DestroyTransform.
	DirectedDistance	Returns the distance a point is as projected on another vector. The result is the distance along that vector from the origin.
	Distance	Returns the distance between two points.
	dotproduct	This is function sack::math::vector::dotproduct.
	Forward	Sets the forward direction speed in a PTRANSFORM.
	GetAccel	This is function sack::math::vector::GetAccel.
	GetAxis	This is function sack::math::vector::GetAxis.
	GetAxisV	This is function sack::math::vector::GetAxisV.
	GetGLMatrix	This is function sack::math::vector::GetGLMatrix.
	GetOrigin	This is function sack::math::vector::GetOrigin.
	GetOriginV	This is function sack::math::vector::GetOriginV.
	GetSpeed	This is function sack::math::vector::GetSpeed.
	Invert	Inverts a vector. that is vector * -1. (a,b,c) = (-a,-b,-c) Parameters
	InvertTransform	Badly named function. InvertTransform turns a transform sideways, that is takes axis-normal transforms and turns them for sending to other graphic systems.
	Length	Returns the scalar length of a vector.
	LoadTransform	Recovers a transformation state from a file.
	Move	Updates a transform by it's current speed and rotation assuming speed and rotation are specified in x per 1 second. Applies the fraction of time between now and the prior time move was called and scales speed and rotation by that when applying it.
	normalize	Normalizes a non-zero vector. That is the resulting length of the vector is 1.0. Modifies the vector in place.
	PrintMatrixEx	Dumps to syslog a current matrix. Shows both matrix content, and the cross products between the matrix that cross1 should be row 0, cross2 should be row 1 and cross3 should be row2. Pass a text name to identify this matrix from others.
	PrintVectorEx	Logs the vector and leader to log. the leader is called lpName, cause it was inteded to be used by just the vector name.
	PrintVectorStdEx	Same as PrintVectorEx, but prints to standard output using printf.
	project	result is the projection of project onto onto
	Right	Sets the right direction speed in a PTRANSFORM.
	RotateAbs	This is function sack::math::vector::RotateAbs.
	RotateAbsV	This is function sack::math::vector::RotateAbsV.
	RotateAround	Rotates a transform around some arbitrary axis. (any line may be used to rotate the transformation's rotation matrix)
	RotateAroundMast	Rotates around the 'up' of the current rotation matrix. Same as a yaw rotation.
	RotateMast	Sets the current 'up' axis of a transformation. The forward axis is adjusted so that it remains perpendicular to the mast axis vs the right axis. After the forward axis is updated, the right axis is adjusted to be perpendicular to up and forward.
	RotateRel	Updates the current rotation matrix of a transform by a relative amount. Amounts to rotate about the x, y and z axii are given in radians.
	RotateRelV	Update a transformation matrix by relative degress about the x axix, y axis and z axis.
	RotateRight	This is function sack::math::vector::RotateRight.
	RotateTo	This is function sack::math::vector::RotateTo.
	SaveTransform	Provides a way to save a matrix ( direct binary file dump)
	scale	Scales a vector by a scalar
	Scale	This is function sack::math::vector::Scale.
	SetAccel	Sets the acceleration applied to the speed when Move is called.
	SetAxis	This is function sack::math::vector::SetAxis.
	SetAxisV	This is function sack::math::vector::SetAxisV.
	SetRotation	This is function sack::math::vector::SetRotation.
	SetSpeed	Set the speed vector used when Move is applied to a PTRANSFORM.
	SetTimeInterval	Set how long it takes, in milliseconds, to move 1 unit of speed vector or rotate 1 unit of rotation vector when Move is called. Each matrix maintains a last tick. If many thousands of matrixes were used, probably a batch move could be implemented that would maintain tick counts for a group of matrixes... don't know how long it takes to compute move, but timeGetTime will slow it down a lot.
	showstd	This is function sack::math::vector::showstd.
	showstdEx	This is function sack::math::vector::showstdEx.
	ShowTransformEx	This is function sack::math::vector::ShowTransformEx.
	SinAngle	Returns the sin of the angle between two vectors.
	sub	subtracts two vectors and stores the result in another vector.
	Translate	This is function sack::math::vector::Translate.
	TranslateRel	This is function sack::math::vector::TranslateRel.
	TranslateRelV	This is function sack::math::vector::TranslateRelV.
	TranslateV	This is function sack::math::vector::TranslateV.
	Up	Sets the up direction speed in a PTRANSFORM.

Macros

Name	Description
_15	a hard coded define that represents a 15 degree angle in radians.
_30	a hard coded define that represents a 30 degree angle in radians.
_45	a hard coded define that represents a 45 degree angle in radians.
_5	a hard coded define that represents a 5 degree angle in radians.
CreateTransform	This is macro sack::math::vector::CreateTransform.
e1	This is 'epsilon' that is used with by NearZero comparison macro.
EXPON	Macro to extract the exponent part of a RCOORD.
InvertVector	Macro which can be used to make a vector's direction be exactly opposite of what it is now.
M_PI	symbol to define a double precision value for PI if it doesn't exist in the compiler.
Near	compares two vectors to see if they are near each other. Boundary conditions exist around 0, when the values are on opposite sides, but it's pretty good.
NearZero	Checks to see if a coordinate is 0 or near 0.
NEG_INFINITY	a symbol which is effectively the largest negative value of the space, anything less than this is untrackable, and is the same as infinity.
ONE	Special symbol that is the unit quantity.
POS_INFINITY	a symbol which is effectively the largest value of the space, anything more than this is untrackable, and is the same as infinity.
PrintMatrix	Dumps to syslog a current matrix. Shows both matrix content, and the cross products between the matrix that cross1 should be row 0, cross2 should be row 1 and cross3 should be row2. Pass a text name to identify this matrix from others.
PrintVector	Logs the vector and leader to log. the leader is called lpName, cause it was inteded to be used by just the vector name.
PrintVectorStd	Same as PrintVectorEx, but prints to standard output using printf.
RCOORD_IS_DOUBLE	Define that an RCOORD is represented by the basic type 'double' for platforms with smaller fast floating point types, this could be float.
RCOORDBITS	A macro to get the literal bits into an unsigned value of the same size. Shift and binary operators do not apply to floating point values, but floating point values are fields of bits that represent fractional parts of integers. This gets the bits so the fields can be tested.
SetPoint	should end up layering this macro based on DIMENSIONS
SetRay	copies the value of a ray into another ray
ShowTransform	This is function sack::math::vector::ShowTransformEx.
THRESHOLD	THRESHOLD may be any number more than 1. eveything 0 or more makes pretty much every number which is anything like another number equal... threshold is in count of bits... therefore for 1millionth digit accuracy that would be 20 bits. 10 bits is thousanths different are near 0 bits is if the same magnitude of number... but may be quite different -10 bits is thousands different are near 1 == 1.5 1 == 1.01
ZERO	relics from fixed point math dayz....

Structs, Records, Enums

	Name	Description
	lineseg_tag	This is a pure abstraction of a Line. It is used in the basis of 3d graphics.
	orthoarea_tag	A representation of a rectangular 2 dimensional area.
	vectlib_ray_type	A ray is a type that has an origin and a direction. (It is a pair of vectors actually)

Types

Name	Description
_POINT	include "../src/vectlib/vecstruc.h
CPCTRANSFORM	Constant pointer to a constant transform. For things like _I transformation which is the identity translation.
LINESEG
MATRIX	these SHOULD be dimension relative, but we lack much code for that...
MotionCallback	after Move() these callbacks are invoked.
ORTHOAREA	A representation of a rectangular 2 dimensional area.
P_POINT	pointer to a point.
PC_POINT	pointer to a constant point.
PCTRANSFORM	Pointer to a constant transform.
PCVECTOR	pointer to a constant vector.
PLINESEG	This is a pure abstraction of a Line. It is used in the basis of 3d graphics.
PMATRIX	Describes the rotation matrix for a PTRANSFORM.
PORTHOAREA	A representation of a rectangular 2 dimensional area.
PRAY
PRCOORD
PTRANSFORM
PVECTOR	pointer to a vector.
RAY
RCOORD	basic type that Vectlib is based on. This specifies a 'real' (aka float) coordinate. Combinations of coordinates create vectors and points.
TRANSFORM
VECTOR	A vector type. Contains 3 values by default, library can handle 4 dimensional transformations(?)

Variables

Name	Description
_0	Constants for origin(0,0,0), and axii
_I	This is a static constant identity matrix, which can be used to initialize a matrix transform (internally).
_X	Specifies the coordinate system's X axis direction. static constant.
_Y	Specifies the coordinate system's Y axis direction. static constant.
_Z	Specifies the coordinate system's Z axis direction. static constant.

Links

sack::math Namespace, Legend, Topics, Functions, Macros, Structs, Records, Enums, Types, Variables

Created with a commercial version of

Doc-O-Matic. In order to make this message disappear you need to register this software. If you have problems registering this software please contact us at

support@toolsfactory.com.

Contents | Index | Reference | Home

What do you think about this topic? Send feedback!