Matrix3Stack Class Reference

#include <stack3.h>

Public Member Functions
	Matrix3Stack ()
	Matrix3Stack (int depth)
	~Matrix3Stack ()
	Matrix3Stack (const Matrix3Stack &)=delete
Matrix3Stack &	operator= (const Matrix3Stack &)=delete
bool	replace (const Matrix3 &m)
bool	push (const Matrix3 &m)
bool	dup (void)
bool	concat (const Matrix3 &m)
Matrix3 &	get (void)
Matrix3 &	pop (void)
bool	remove (void)
bool	reset (void)

Detailed Description

See also

Class Matrix3.

Description:

A stack of Matrix3's (4x3 matrix). All methods of this class are implemented by the system. No error (bounds) checking is performed.

Constructor & Destructor Documentation

Matrix3Stack() [1/3]

Matrix3Stack

(

)

Remarks

Constructor. Creates a new 32 element stack of Matrix3s.

Matrix3Stack() [2/3]

Matrix3Stack

(

int

depth

)

Remarks

Constructor. Creates a new depth element stack of Matrix3s.

~Matrix3Stack()

~Matrix3Stack

(

)

Remarks

Destructor. Frees the stack.

Matrix3Stack() [3/3]

Matrix3Stack ( const Matrix3Stack &  )

delete

Member Function Documentation

operator=()

Matrix3Stack & operator= ( const Matrix3Stack &  )

delete

replace()

bool replace ( const Matrix3 &  m )

inline

Remarks

Replaces the item on the top of the stack with the specified matrix.

Parameters:

const Matrix3 &m

The matrix to replace the matrix at the top of the stack.

Returns

Always TRUE.

    {
        stk[index] = m;
        return true;
    }

push()

bool push ( const Matrix3 &  m )

inline

Remarks

Pushes the specified matrix onto the stack.

Parameters:

const Matrix3 &m

The matrix to push on the top of the stack.

Returns

TRUE if there is still room on the stack; otherwise FALSE.

    {
        stk[index++] = m;
        return index < maxDepth;
    }

dup()

bool dup ( void  )

inline

Remarks

Duplicates the matrix on the top of the stack.

Returns

TRUE if there is still room on the stack after the dup; otherwise FALSE.

    {
        stk[index + 1] = stk[index];
        return ++index < maxDepth;
    }

concat()

bool concat ( const Matrix3 &  m )

inline

Remarks

Concatenates the specified matrix with the matrix on the top of the stack (performs matrix multiplication).

Parameters:

const Matrix3 &m

The matrix to multiply (m * stack[top]).

Returns

Always TRUE.

    {
        stk[index] = m * stk[index];
        return true;
    }

get()

Matrix3 & get ( void  )

inline

Remarks

Returns the matrix on the top of the stack.

    {
        return stk[index];
    }

pop()

Matrix3 & pop ( void  )

inline

Remarks

Pops the matrix from the stack.

Returns

The matrix at the top of the stack.

    {
        return stk[index--];
    }

remove()

bool remove ( void  )

inline

Remarks

Removes the matrix at the top of the stack.

Returns

TRUE if the number of items on the stack is >= 0 (after removing the matrix); otherwise 0.

    {
        return --index >= 0;
    }

reset()

bool reset ( void  )

inline

Remarks

Resets the stack to contain zero items.

Returns

Always TRUE.

    {
        index = 0;
        stk[0].IdentityMatrix();
        return true;
    }