com.cycling74.jitter
Class JitterMatrix

java.lang.Object
  |
  +--com.cycling74.jitter.JitterObject
        |
        +--com.cycling74.jitter.JitterMatrix

public class JitterMatrix
extends JitterObject

JitterMatrix is a java wrapper for the Jitter Matrix object

Author:
Joshua Kit Clayton

Fields inherited from class com.cycling74.jitter.JitterObject
_p_obj
 
Constructor Summary
JitterMatrix()
          creates a JitterMatrix with default planecount, type, dimensions and auto-generated name
JitterMatrix(com.cycling74.max.Atom[] args)
          creates a JitterMatrix with atom arguments which parallel those typed into a max object box
JitterMatrix(java.awt.image.BufferedImage img)
          creates a 4 plane char JitterMatrix with the data from a BufferedImage
JitterMatrix(int planecount, java.lang.String type, int x_dim)
          creates a JitterMatrix with auto-generated name
JitterMatrix(int planecount, java.lang.String type, int[] dim)
          creates a JitterMatrix with auto-generated name
JitterMatrix(int planecount, java.lang.String type, int x_dim, int y_dim)
          creates a JitterMatrix with auto-generated name
JitterMatrix(int planecount, java.lang.String type, int x_dim, int y_dim, int z_dim)
          creates a JitterMatrix with auto-generated name
JitterMatrix(java.lang.String name)
          creates a JitterMatrix with a specific name and default planecount, type, and dimensions if the named matrix does not already exist
JitterMatrix(java.lang.String name, int planecount, java.lang.String type, int x_dim)
          creates a JitterMatrix with a specific name
JitterMatrix(java.lang.String name, int planecount, java.lang.String type, int[] dim)
          creates a JitterMatrix with a specific name
JitterMatrix(java.lang.String name, int planecount, java.lang.String type, int x_dim, int y_dim)
          creates a JitterMatrix with a specific name
JitterMatrix(java.lang.String name, int planecount, java.lang.String type, int x_dim, int y_dim, int z_dim)
          creates a JitterMatrix with a specific name
 
Method Summary
 void clear()
          clears the peer Jitter matrix
 int copyArrayToVector(int dim, int[] offset, double[] array, int count, int arrayoffset)
          copies a double array to a vector in the JitterMatrix
 int copyArrayToVector(int dim, int[] offset, float[] array, int count, int arrayoffset)
          copies a float array to a vector in the JitterMatrix
 int copyArrayToVector(int dim, int[] offset, int[] array, int count, int arrayoffset)
          copies an integer array to a vector in the JitterMatrix
 int copyArrayToVectorPlanar(int plane, int dim, int[] offset, double[] array, int count, int arrayoffset)
          copies a double array to a single plane in a vector in the JitterMatrix
 int copyArrayToVectorPlanar(int plane, int dim, int[] offset, float[] array, int count, int arrayoffset)
          copies a float array to a single plane in a vector in the JitterMatrix
 int copyArrayToVectorPlanar(int plane, int dim, int[] offset, int[] array, int count, int arrayoffset)
          copies an integer array to a single plane in a vector in the JitterMatrix
 void copyBufferedImage(java.awt.image.BufferedImage img)
          Copies data from a BufferedImage into a matrix, resizing the matrix if necessary
 int copyVectorToArray(int dim, int[] offset, double[] array, int count, int arrayoffset)
          copies a vector from the JitterMatrix to a double array
 int copyVectorToArray(int dim, int[] offset, float[] array, int count, int arrayoffset)
          copies a vector from the JitterMatrix to a float array
 int copyVectorToArray(int dim, int[] offset, int[] array, int count, int arrayoffset)
          copies a vector from the JitterMatrix to an integer array
 int copyVectorToArrayPlanar(int plane, int dim, int[] offset, double[] array, int count, int arrayoffset)
          copies a single plane from a vector from the JitterMatrix to a double array
 int copyVectorToArrayPlanar(int plane, int dim, int[] offset, float[] array, int count, int arrayoffset)
          copies a single plane from a vector from the JitterMatrix to a float array
 int copyVectorToArrayPlanar(int plane, int dim, int[] offset, int[] array, int count, int arrayoffset)
          copies a single plane from a vector from the JitterMatrix to an integer array
 java.awt.image.BufferedImage createBufferedImage()
          Creates a BufferedImage from the contents of the matrix.
 com.cycling74.max.Atom[] exportimage()
          calls the exportimage method
 com.cycling74.max.Atom[] exportimage(com.cycling74.max.Atom[] args)
          calls the exportimage method
 com.cycling74.max.Atom[] exportimage(java.lang.String filename)
          calls the exportimage method
 com.cycling74.max.Atom[] exportmovie()
          calls the exportmovie method
 com.cycling74.max.Atom[] exportmovie(com.cycling74.max.Atom[] args)
          calls the exportmovie method
 com.cycling74.max.Atom[] exportmovie(java.lang.String filename)
          calls the exportmovie method
 void frommatrix(JitterMatrix matrix)
          sends the frommatrix message
 void frommatrix(java.lang.String matrixname)
          sends the frommatrix message
 boolean getAdapt()
           
 com.cycling74.max.Atom[] getcell(int[] position)
          sends getcell message
 com.cycling74.max.Atom[] getcell1d(int x)
          gets the value of a cell from a one-dimensional matrix
 double[] getcell1dDouble(int x)
          gets the value of a cell from a one-dimensional double matrix
 float[] getcell1dFloat(int x)
          gets the value of a cell from a one-dimensional float32 matrix
 int[] getcell1dInt(int x)
          gets the value of a cell from a one-dimensional char or long matrix
 com.cycling74.max.Atom[] getcell2d(int x, int y)
          gets the value of a cell from a two-dimensional matrix
 double[] getcell2dDouble(int x, int y)
          gets the value of a cell from a two-dimensional double matrix
 float[] getcell2dFloat(int x, int y)
          gets the value of a cell from a two-dimensional float32 matrix
 int[] getcell2dInt(int x, int y)
          gets the value of a cell from a two-dimensional char or long matrix
 com.cycling74.max.Atom[] getcell3d(int x, int y, int z)
          gets the value of a cell from a three-dimensional matrix
 double[] getcell3dDouble(int x, int y, int z)
          gets the value of a cell from a three-dimensional double matrix
 float[] getcell3dFloat(int x, int y, int z)
          gets the value of a cell from a three-dimensional float32 matrix
 int[] getcell3dInt(int x, int y, int z)
          gets the value of a cell from a three-dimensional char or long matrix
 double[] getcellDouble(int[] position)
          gets the value of a cell from a double matrix
 float[] getcellFloat(int[] position)
          gets the value of a cell from a float32 matrix
 int[] getcellInt(int[] position)
          gets the value of a cell from a char or long matrix
 int[] getDim()
           
 int[] getDstdimend()
           
 int[] getDstdimstart()
           
 boolean getInterp()
           
 java.lang.String getName()
           
 int getPlanecount()
           
 int[] getPlanemap()
           
 int[] getSrcdimend()
           
 int[] getSrcdimstart()
           
 java.lang.String getType()
           
 boolean getUsedstdim()
           
 boolean getUsesrcdim()
           
 java.lang.String importmovie()
          sends the importmovie message without arguments
 java.lang.String importmovie(com.cycling74.max.Atom[] args)
          sends the importmovie message with arguments
 java.lang.String importmovie(java.lang.String filename)
          sends the importmovie message with a specified filename
 void op(java.lang.String op)
          sends an op message with specified operator
 void op(java.lang.String op, double val)
          sends an op message with specified operator and double operand
 void op(java.lang.String op, double[] vals)
          sends an op message with specified operator, and double operands
 void op(java.lang.String op, float val)
          sends an op message with specified operator and float operand
 void op(java.lang.String op, float[] vals)
          sends an op message with specified operator, and float operands
 void op(java.lang.String op, int val)
          sends an op message with specified operator and integer operand
 void op(java.lang.String op, int[] vals)
          sends an op message with specified operator, and integer operands
 void op(java.lang.String op, JitterMatrix matrix)
          sends an op message with specified operator and operand JitterMatrix
 void op(java.lang.String op, JitterMatrix matrix, double val)
          sends an op message with specified operator, operand JitterMatrix, and double operand
 void op(java.lang.String op, JitterMatrix matrix, double[] vals)
          sends an op message with specified operator, a JitterMatrix operand, and double operands
 void op(java.lang.String op, JitterMatrix matrix, float val)
          sends an op message with specified operator, operand JitterMatrix, and float operand
 void op(java.lang.String op, JitterMatrix matrix, float[] vals)
          sends an op message with specified operator, a JitterMatrix operand, and float operands
 void op(java.lang.String op, JitterMatrix matrix, int val)
          sends an op message with specified operator, operand JitterMatrix, and integer operand
 void op(java.lang.String op, JitterMatrix matrix, int[] vals)
          sends an op message with specified operator, a JitterMatrix operand, and integer operands
 void op(java.lang.String op, JitterMatrix a_matrix, JitterMatrix b_matrix)
          sends an op message with specified operator and two operand JitterMatrixs
 void op(java.lang.String op, java.lang.String matrixname)
          sends an op message with specified operator and operand matrix name
 void op(java.lang.String op, java.lang.String matrixname, double val)
          sends an op message with specified operator, operand matrix name, and double operand
 void op(java.lang.String op, java.lang.String matrixname, double[] vals)
          sends an op message with specified operator, named matrix operand, and double operands
 void op(java.lang.String op, java.lang.String matrixname, float val)
          sends an op message with specified operator, operand matrix name, and float operand
 void op(java.lang.String op, java.lang.String matrixname, float[] vals)
          sends an op message with specified operator, named matrix operand, and float operands
 void op(java.lang.String op, java.lang.String matrixname, int val)
          sends an op message with specified operator, operand matrix name, and integer operand
 void op(java.lang.String op, java.lang.String matrixname, int[] vals)
          sends an op message with specified operator, named matrix operand, and integer operands
 void op(java.lang.String op, java.lang.String a_matrixname, java.lang.String b_matrixname)
          sends an op message with specified operator and two named operand matrices
 com.cycling74.max.Atom[] read()
          sends a read message
 com.cycling74.max.Atom[] read(com.cycling74.max.Atom[] args)
          sends a read message with arguments
 com.cycling74.max.Atom[] read(java.lang.String filename)
          sends a read message with specified filename
 boolean setAdapt(boolean on)
           
 boolean setAdapt(int on)
           
 void setall(com.cycling74.max.Atom val)
          sends a setall message
 void setall(com.cycling74.max.Atom[] vals)
          sends a setall message
 void setall(double val)
          sends a setall message
 void setall(double[] vals)
          sends a setall message
 void setall(float val)
          sends a setall message
 void setall(float[] vals)
          sends a setall message
 void setall(int val)
          sends a setall message
 void setall(int[] vals)
          sends a setall message
 void setcell(com.cycling74.max.Atom[] args)
          sends a setcell message
 void setcell(int[] position, double[] vals)
          sends a setcell message
 void setcell(int[] position, float[] vals)
          sends a setcell message
 void setcell(int[] position, int[] vals)
          sends a setcell message
 void setcell(int[] position, int plane, double val)
          sends a setcell message
 void setcell(int[] position, int plane, float val)
          sends a setcell message
 void setcell(int[] position, int plane, int val)
          sends a setcell message
 void setcell1d(int x, double[] vals)
          sets the values of a cell in a one-dimensional matrix
 void setcell1d(int x, float[] vals)
          sets the values of a cell in a one-dimensional matrix
 void setcell1d(int x, int[] vals)
          sets the values of a cell in a one-dimensional matrix
 void setcell2d(int x, int y, double[] vals)
          sets the values of a cell in a two-dimensional matrix
 void setcell2d(int x, int y, float[] vals)
          sets the values of a cell in a two-dimensional matrix
 void setcell2d(int x, int y, int[] vals)
          sets the values of a cell in a two-dimensional matrix
 void setcell3d(int x, int y, int z, double[] vals)
          sets the values of a cell in a three-dimensional matrix
 void setcell3d(int x, int y, int z, float[] vals)
          sets the values of a cell in a three-dimensional matrix
 void setcell3d(int x, int y, int z, int[] vals)
          sets the values of a cell in a three-dimensional matrix
 boolean setDim(int[] dim)
           
 boolean setDstdimend(int[] dim)
           
 boolean setDstdimstart(int[] dim)
          sets the dstdimstart attribute for the peer Jitter matrix
 void setinfo(JitterMatrix matrix)
          sends a setinfo message, which sets the matrix dimensions to those of the argument matrix
 void setinfo(java.lang.String matrixname)
          sends a setinfo message, which sets the matrix dimensions to those of the argument matrix
 boolean setInterp(boolean on)
          sets the interp attribute of the peer Jitter matrix
 boolean setInterp(int on)
          sets the interp attribute of the peer Jitter matrix
 boolean setName(java.lang.String name)
          sets the name attribute of the peer Jitter matrix
 boolean setPlanecount(int count)
          sets the planecount attribute of the peer Jitter matrix
 boolean setPlanemap(int[] map)
          sets the values of the planemap attribute of the peer Jitter matrix
 boolean setSrcdimend(int[] dim)
          sets the values of the srcdimend attribute of the peer Jitter matrix
 boolean setSrcdimstart(int[] dim)
          sets the values of the srcdimstart attribute of the peer Jitter matrix
 boolean setType(java.lang.String type)
          sets the value of the type attribute of the peer Jitter matrix
 com.cycling74.max.Atom[] write()
          sends a write message to save the matrix to disk
 com.cycling74.max.Atom[] write(com.cycling74.max.Atom[] args)
          sends a write message to save the matrix to disk
 com.cycling74.max.Atom[] write(java.lang.String filename)
          sends a write message to save the matrix to disk
 
Methods inherited from class com.cycling74.jitter.JitterObject
_new, bang, call, call, call, call, call, call, call, call, finalize, freePeer, getAttr, getAttrFloat, getAttrFloatArray, getAttrInt, getAttrIntArray, getAttrString, getAttrStringArray, getJitterClass, matrixcalc, send, send, send, send, send, send, send, send, send, send, setAttr, setAttr, setAttr, setAttr, setAttr, setAttr, setAttr, understands
 
Methods inherited from class java.lang.Object
clone, equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

JitterMatrix

public JitterMatrix()
creates a JitterMatrix with default planecount, type, dimensions and auto-generated name

JitterMatrix

public JitterMatrix(java.lang.String name)
creates a JitterMatrix with a specific name and default planecount, type, and dimensions if the named matrix does not already exist
Parameters:
name - the name of the peer Jitter matrix object

JitterMatrix

public JitterMatrix(com.cycling74.max.Atom[] args)
creates a JitterMatrix with atom arguments which parallel those typed into a max object box
Parameters:
args - instantiation arguments for the peer Jitter matrix

JitterMatrix

public JitterMatrix(int planecount,
                    java.lang.String type,
                    int[] dim)
creates a JitterMatrix with auto-generated name
Parameters:
planecount - the number of planes
type - the type of matrix: "char", "long", "float32", "float64"
dim - the size of the dimensions

JitterMatrix

public JitterMatrix(java.lang.String name,
                    int planecount,
                    java.lang.String type,
                    int[] dim)
creates a JitterMatrix with a specific name
Parameters:
name - the name of the peer Jitter matrix object
planecount - the number of planes
type - the type of matrix: "char", "long", "float32", "float64"
dim - the size of the dimensions

JitterMatrix

public JitterMatrix(int planecount,
                    java.lang.String type,
                    int x_dim)
creates a JitterMatrix with auto-generated name
Parameters:
planecount - the number of planes
type - the type of matrix: "char", "long", "float32", "float64"
x_dim - the size of the dimension

JitterMatrix

public JitterMatrix(java.lang.String name,
                    int planecount,
                    java.lang.String type,
                    int x_dim)
creates a JitterMatrix with a specific name
Parameters:
name - the name of the peer Jitter matrix object
planecount - the number of planes
type - the type of matrix: "char", "long", "float32", "float64"
x_dim - the size of the dimension

JitterMatrix

public JitterMatrix(int planecount,
                    java.lang.String type,
                    int x_dim,
                    int y_dim)
creates a JitterMatrix with auto-generated name
Parameters:
planecount - the number of planes
type - the type of matrix: "char", "long", "float32", "float64"
x_dim - the size of dimension 0
y_dim - the size of dimension 1

JitterMatrix

public JitterMatrix(java.lang.String name,
                    int planecount,
                    java.lang.String type,
                    int x_dim,
                    int y_dim)
creates a JitterMatrix with a specific name
Parameters:
name - the name of the peer Jitter matrix object
planecount - the number of planes
type - the type of matrix: "char", "long", "float32", "float64"
x_dim - the size of dimension 0
y_dim - the size of dimension 1

JitterMatrix

public JitterMatrix(int planecount,
                    java.lang.String type,
                    int x_dim,
                    int y_dim,
                    int z_dim)
creates a JitterMatrix with auto-generated name
Parameters:
planecount - the number of planes
type - the type of matrix: "char", "long", "float32", "float64"
x_dim - the size of dimension 0
y_dim - the size of dimension 1
z_dim - the size of dimension 2

JitterMatrix

public JitterMatrix(java.lang.String name,
                    int planecount,
                    java.lang.String type,
                    int x_dim,
                    int y_dim,
                    int z_dim)
creates a JitterMatrix with a specific name
Parameters:
name - the name of the peer Jitter matrix object
planecount - the number of planes
type - the type of matrix: "char", "long", "float32", "float64"
x_dim - the size of dimension 0
y_dim - the size of dimension 1
z_dim - the size of dimension 2

JitterMatrix

public JitterMatrix(java.awt.image.BufferedImage img)
creates a 4 plane char JitterMatrix with the data from a BufferedImage
Parameters:
img - the BufferedImage to copy data from
Method Detail

getAdapt

public boolean getAdapt()
Returns:
the value of the adapt attribute for the peer Jitter matrix

getDim

public int[] getDim()
Returns:
the values of the dim attribute

getDstdimend

public int[] getDstdimend()
Returns:
the values of the dstdimend attribute

getDstdimstart

public int[] getDstdimstart()
Returns:
the values of the dstdimstart attribute

getInterp

public boolean getInterp()
Returns:
the value of the interp attribute

getName

public java.lang.String getName()
Returns:
the name of the peer Jitter matrix

getPlanecount

public int getPlanecount()
Returns:
the planecount of the peer Jitter matrix

getPlanemap

public int[] getPlanemap()
Returns:
the planemap of the peer Jitter matrix

getSrcdimend

public int[] getSrcdimend()
Returns:
the srcdimend of the peer Jitter matrix

getSrcdimstart

public int[] getSrcdimstart()
Returns:
the srcdimstart of the peer Jitter matrix

getType

public java.lang.String getType()
Returns:
the type of the peer Jitter matrix

getUsedstdim

public boolean getUsedstdim()
Returns:
the usedstdim of the peer Jitter matrix

getUsesrcdim

public boolean getUsesrcdim()
Returns:
the usesrcdim of the peer Jitter matrix

setAdapt

public boolean setAdapt(int on)
Parameters:
on - the value of the adapt attribute to set for the peer Jitter matrix
Returns:
whether the attribute was successfully set or not

setAdapt

public boolean setAdapt(boolean on)
Parameters:
on - the value of the adapt attribute to set for the peer Jitter matrix
Returns:
whether the attribute was successfully set or not

setDim

public boolean setDim(int[] dim)
Parameters:
dim - the values of the dim attribute to set for the peer Jitter matrix
Returns:
whether the attribute was set successfully or not

setDstdimend

public boolean setDstdimend(int[] dim)
Parameters:
dim - the values of the dstdimend attribute to set for the peer Jitter matrix
Returns:
whether the attribute was set successfully or not

setDstdimstart

public boolean setDstdimstart(int[] dim)
sets the dstdimstart attribute for the peer Jitter matrix
Parameters:
dim - the values of the dstdimstart attribute to set
Returns:
whether the attribute was set successfully or not

setName

public boolean setName(java.lang.String name)
sets the name attribute of the peer Jitter matrix
Parameters:
name - the value of the name attribute to set
Returns:
whether the attribute was set successfully or not

setInterp

public boolean setInterp(int on)
sets the interp attribute of the peer Jitter matrix
Parameters:
on - the value of the interp attribute to set
Returns:
whether the attribute was set successfully or not

setInterp

public boolean setInterp(boolean on)
sets the interp attribute of the peer Jitter matrix
Parameters:
on - the value of the interp attribute to set
Returns:
whether the attribute was set successfully or not

setPlanecount

public boolean setPlanecount(int count)
sets the planecount attribute of the peer Jitter matrix
Parameters:
count - the value of the count attribute to set
Returns:
whether the attribute was set successfully or not

setPlanemap

public boolean setPlanemap(int[] map)
sets the values of the planemap attribute of the peer Jitter matrix
Parameters:
map - the values of the map attribute to set
Returns:
whether the attribute was set successfully or not

setSrcdimend

public boolean setSrcdimend(int[] dim)
sets the values of the srcdimend attribute of the peer Jitter matrix
Parameters:
dim - the values of the scrdimend attribute to set
Returns:
whether the attribute was set successfully or not

setSrcdimstart

public boolean setSrcdimstart(int[] dim)
sets the values of the srcdimstart attribute of the peer Jitter matrix
Parameters:
dim - the values of the srcdimstart attribute to set
Returns:
whether the attribute was set successfully or not

setType

public boolean setType(java.lang.String type)
sets the value of the type attribute of the peer Jitter matrix
Parameters:
type - the value of the type attribute to set
Returns:
whether the attribute was set successfully or not

clear

public void clear()
clears the peer Jitter matrix

exportimage

public com.cycling74.max.Atom[] exportimage()
calls the exportimage method
Returns:
an empty arra

exportimage

public com.cycling74.max.Atom[] exportimage(java.lang.String filename)
calls the exportimage method
Parameters:
filename - the name of the file to export into
Returns:
an empty array

exportimage

public com.cycling74.max.Atom[] exportimage(com.cycling74.max.Atom[] args)
calls the exportimage method
Parameters:
args - arguments to the exportimage method: [filename (symbol)] { [file-type (symbol)] } { [use-dialog (int)] }
Returns:
an empty array

exportmovie

public com.cycling74.max.Atom[] exportmovie()
calls the exportmovie method
Returns:
an empty array

exportmovie

public com.cycling74.max.Atom[] exportmovie(java.lang.String filename)
calls the exportmovie method
Parameters:
filename - the name of the file to export into
Returns:
an empty array

exportmovie

public com.cycling74.max.Atom[] exportmovie(com.cycling74.max.Atom[] args)
calls the exportmovie method
Parameters:
args - arguments to the exportmovie method: { [filename (symbol)] } [FPS (float)] [codec (symbol)] [quality (symbol)] [timescale (int)]
Returns:
an empty array

frommatrix

public void frommatrix(java.lang.String matrixname)
sends the frommatrix message
Parameters:
matrixname - the name of the matrix to duplicate

frommatrix

public void frommatrix(JitterMatrix matrix)
sends the frommatrix message
Parameters:
matrix - the JitterMatrix to duplicate

copyBufferedImage

public void copyBufferedImage(java.awt.image.BufferedImage img)
Copies data from a BufferedImage into a matrix, resizing the matrix if necessary
Parameters:
img - the BufferedImage to copy data from

createBufferedImage

public java.awt.image.BufferedImage createBufferedImage()
Creates a BufferedImage from the contents of the matrix. The matrix must be a two-dimensional char matrix.
Parameters:
j -  
Returns:
 

getcell

public com.cycling74.max.Atom[] getcell(int[] position)
sends getcell message
Parameters:
position - the indices of the cell to get
Returns:
the plane values of the requested cell

getcell1d

public com.cycling74.max.Atom[] getcell1d(int x)
gets the value of a cell from a one-dimensional matrix
Parameters:
x - the index of the cell
Returns:
the plane values of the requested cell

getcell2d

public com.cycling74.max.Atom[] getcell2d(int x,
                                          int y)
gets the value of a cell from a two-dimensional matrix
Parameters:
x - the x index of the cell
y - th y index of the cell
Returns:
the plane values of the requested cell

getcell3d

public com.cycling74.max.Atom[] getcell3d(int x,
                                          int y,
                                          int z)
gets the value of a cell from a three-dimensional matrix
Parameters:
x - the x index of the cell
y - the y index of the cell
z - the z index of the cell
Returns:
the plane values of the requested cell

getcellInt

public int[] getcellInt(int[] position)
gets the value of a cell from a char or long matrix
Parameters:
position - an array that contains the indices of the cell
Returns:
the plane values of the requested cell

getcell1dInt

public int[] getcell1dInt(int x)
gets the value of a cell from a one-dimensional char or long matrix
Parameters:
x - the index of the cell
Returns:
the plane values of the requested cell

getcell2dInt

public int[] getcell2dInt(int x,
                          int y)
gets the value of a cell from a two-dimensional char or long matrix
Parameters:
x - the x index of the cell
y - the y index of the cell
Returns:
the plane values of the requested cell

getcell3dInt

public int[] getcell3dInt(int x,
                          int y,
                          int z)
gets the value of a cell from a three-dimensional char or long matrix
Parameters:
x - the x index of the cell
y - the y index of the cell
z - the z index of the cell
Returns:
the plane values of the requested cell

getcellFloat

public float[] getcellFloat(int[] position)
gets the value of a cell from a float32 matrix
Parameters:
position - an array that contains the indices of the cell
Returns:
the plane values of the requested cell

getcell1dFloat

public float[] getcell1dFloat(int x)
gets the value of a cell from a one-dimensional float32 matrix
Parameters:
x - the index of the cell
Returns:
the plane values of the requested cell

getcell2dFloat

public float[] getcell2dFloat(int x,
                              int y)
gets the value of a cell from a two-dimensional float32 matrix
Parameters:
x - the x index of the cell
y - the y index of the cell
Returns:
the plane values of the requested cell

getcell3dFloat

public float[] getcell3dFloat(int x,
                              int y,
                              int z)
gets the value of a cell from a three-dimensional float32 matrix
Parameters:
x - the x index of the cell
y - the y index of the cell
z - the z index of the cell
Returns:
the plane values of the requested cell

getcellDouble

public double[] getcellDouble(int[] position)
gets the value of a cell from a double matrix
Parameters:
position - an array that contains the indices of the cell
Returns:
the plane values of the requested cell

getcell1dDouble

public double[] getcell1dDouble(int x)
gets the value of a cell from a one-dimensional double matrix
Parameters:
x - the x index of the cell
Returns:
the plane values of the requested cell

getcell2dDouble

public double[] getcell2dDouble(int x,
                                int y)
gets the value of a cell from a two-dimensional double matrix
Parameters:
x - the x index of the cell
y - the y index of the cell
Returns:
the plane values of the requested cell

getcell3dDouble

public double[] getcell3dDouble(int x,
                                int y,
                                int z)
gets the value of a cell from a three-dimensional double matrix
Parameters:
x - the x index of the cell
y - the y index of the cell
z - the z index of the cell
Returns:
the plane values of the requested cell

importmovie

public java.lang.String importmovie()
sends the importmovie message without arguments
Returns:
the name of the movie file if successful, null if unsuccessful

importmovie

public java.lang.String importmovie(java.lang.String filename)
sends the importmovie message with a specified filename
Parameters:
filename - the file name of the movie to import
Returns:
the name of the movie file if successful, null if unsuccessful

importmovie

public java.lang.String importmovie(com.cycling74.max.Atom[] args)
sends the importmovie message with arguments
Parameters:
args - the arguments to append to the message
Returns:
the name of the movie file if successful, null if unsuccessful

op

public void op(java.lang.String op)
sends an op message with specified operator
Parameters:
op - the operator

op

public void op(java.lang.String op,
               java.lang.String matrixname)
sends an op message with specified operator and operand matrix name
Parameters:
op - the operator
matrixname - the operand matrix name

op

public void op(java.lang.String op,
               java.lang.String a_matrixname,
               java.lang.String b_matrixname)
sends an op message with specified operator and two named operand matrices
Parameters:
op - the operator
a_matrixname - operand A matrix name
b_matrixname - operand B matrix name

op

public void op(java.lang.String op,
               JitterMatrix matrix)
sends an op message with specified operator and operand JitterMatrix
Parameters:
op - the operator
matrix - the operand

op

public void op(java.lang.String op,
               JitterMatrix a_matrix,
               JitterMatrix b_matrix)
sends an op message with specified operator and two operand JitterMatrixs
Parameters:
op - the operator
a_matrix - operand A
b_matrix - operand B

op

public void op(java.lang.String op,
               int val)
sends an op message with specified operator and integer operand
Parameters:
op - the operator
val - the operand

op

public void op(java.lang.String op,
               float val)
sends an op message with specified operator and float operand
Parameters:
op - the operator
val - the operand

op

public void op(java.lang.String op,
               double val)
sends an op message with specified operator and double operand
Parameters:
op - the operator
val - the operand

op

public void op(java.lang.String op,
               java.lang.String matrixname,
               int val)
sends an op message with specified operator, operand matrix name, and integer operand
Parameters:
op - the operator
matrixname - the matrix name operand
val - the integer operand

op

public void op(java.lang.String op,
               java.lang.String matrixname,
               float val)
sends an op message with specified operator, operand matrix name, and float operand
Parameters:
op - the operator
matrixname - the matrix name operand
val - the float operand

op

public void op(java.lang.String op,
               java.lang.String matrixname,
               double val)
sends an op message with specified operator, operand matrix name, and double operand
Parameters:
op - the operator
matrixname - the matrix name operand
val - the double operand

op

public void op(java.lang.String op,
               JitterMatrix matrix,
               int val)
sends an op message with specified operator, operand JitterMatrix, and integer operand
Parameters:
op - the operator
matrix - the operand JitterMatrix
val - the integer operand

op

public void op(java.lang.String op,
               JitterMatrix matrix,
               float val)
sends an op message with specified operator, operand JitterMatrix, and float operand
Parameters:
op - the operator
matrix - the operand JitterMatrix
val - the integer operand

op

public void op(java.lang.String op,
               JitterMatrix matrix,
               double val)
sends an op message with specified operator, operand JitterMatrix, and double operand
Parameters:
op - the operator
matrix - the operand JitterMatrix
val - the integer operand

op

public void op(java.lang.String op,
               int[] vals)
sends an op message with specified operator, and integer operands
Parameters:
op - the operator
vals - the integer operands

op

public void op(java.lang.String op,
               float[] vals)
sends an op message with specified operator, and float operands
Parameters:
op - the operator
vals - the float operands

op

public void op(java.lang.String op,
               double[] vals)
sends an op message with specified operator, and double operands
Parameters:
op - the operator
vals - the double operands

op

public void op(java.lang.String op,
               java.lang.String matrixname,
               int[] vals)
sends an op message with specified operator, named matrix operand, and integer operands
Parameters:
op - the operator
matrixname - the name of the matrix operand
vals - the integer operands

op

public void op(java.lang.String op,
               java.lang.String matrixname,
               float[] vals)
sends an op message with specified operator, named matrix operand, and float operands
Parameters:
op - the operator
matrixname - the name of the matrix operand
vals - the float operands

op

public void op(java.lang.String op,
               java.lang.String matrixname,
               double[] vals)
sends an op message with specified operator, named matrix operand, and double operands
Parameters:
op - the operator
matrixname - the name of the matrix operand
vals - the double operands

op

public void op(java.lang.String op,
               JitterMatrix matrix,
               int[] vals)
sends an op message with specified operator, a JitterMatrix operand, and integer operands
Parameters:
op - the operator
matrix - the JitterMatrix operand
vals - the integer operands

op

public void op(java.lang.String op,
               JitterMatrix matrix,
               float[] vals)
sends an op message with specified operator, a JitterMatrix operand, and float operands
Parameters:
op - the operator
matrix - the JitterMatrix operand
vals - the float operands

op

public void op(java.lang.String op,
               JitterMatrix matrix,
               double[] vals)
sends an op message with specified operator, a JitterMatrix operand, and double operands
Parameters:
op - the operator
matrix - the JitterMatrix operand
vals - the double operands

read

public com.cycling74.max.Atom[] read()
sends a read message
Returns:
nada

read

public com.cycling74.max.Atom[] read(java.lang.String filename)
sends a read message with specified filename
Parameters:
filename - the name of the file
Returns:
nada

read

public com.cycling74.max.Atom[] read(com.cycling74.max.Atom[] args)
sends a read message with arguments
Parameters:
args - the arguments
Returns:
nada

setall

public void setall(com.cycling74.max.Atom val)
sends a setall message
Parameters:
val - all elements will be set to his value

setall

public void setall(com.cycling74.max.Atom[] vals)
sends a setall message
Parameters:
vals - the planes of every cell will be set to these values

setall

public void setall(int val)
sends a setall message
Parameters:
val - all elements will be set to his value

setall

public void setall(int[] vals)
sends a setall message
Parameters:
vals - the planes of every cell will be set to these values

setall

public void setall(float val)
sends a setall message
Parameters:
val - all elements will be set to his value

setall

public void setall(float[] vals)
sends a setall message
Parameters:
vals - the planes of every cell will be set to these values

setall

public void setall(double val)
sends a setall message
Parameters:
val - all elements will be set to his value

setall

public void setall(double[] vals)
sends a setall message
Parameters:
vals - the planes of every cell will be set to these values

setcell

public void setcell(com.cycling74.max.Atom[] args)
sends a setcell message
Parameters:
args - arguments to the message

setcell

public void setcell(int[] position,
                    int[] vals)
sends a setcell message
Parameters:
position - the indices of the cell to set
vals - the planes of the cell will be set to these values

setcell

public void setcell(int[] position,
                    float[] vals)
sends a setcell message
Parameters:
position - the indices of the cell to set
vals - the planes of the cell will be set to these values

setcell

public void setcell(int[] position,
                    double[] vals)
sends a setcell message
Parameters:
position - the indices of the cell to set
vals - the planes of the cell will be set to these values

setcell

public void setcell(int[] position,
                    int plane,
                    int val)
sends a setcell message
Parameters:
position - the indices of the cell to set
plane - the plane to set
val - the specified plane of the specified cell will be set to this value

setcell

public void setcell(int[] position,
                    int plane,
                    float val)
sends a setcell message
Parameters:
position - the indices of the cell to set
plane - the plane to set
val - the specified plane of the specified cell will be set to this value

setcell

public void setcell(int[] position,
                    int plane,
                    double val)
sends a setcell message
Parameters:
position - the indices of the cell to set
plane - the plane to set
val - the specified plane of the specified cell will be set to this value

setcell1d

public void setcell1d(int x,
                      int[] vals)
sets the values of a cell in a one-dimensional matrix
Parameters:
x - the x index of the cell
vals - the values to set

setcell1d

public void setcell1d(int x,
                      float[] vals)
sets the values of a cell in a one-dimensional matrix
Parameters:
x - the x index of the cell
vals - the values to set

setcell1d

public void setcell1d(int x,
                      double[] vals)
sets the values of a cell in a one-dimensional matrix
Parameters:
x - the x index of the cell
vals - the values to set

setcell2d

public void setcell2d(int x,
                      int y,
                      int[] vals)
sets the values of a cell in a two-dimensional matrix
Parameters:
x - the x index of the cell
y - the y index of the cell
vals - the values to set

setcell2d

public void setcell2d(int x,
                      int y,
                      float[] vals)
sets the values of a cell in a two-dimensional matrix
Parameters:
x - the x index of the cell
y - the y index of the cell
vals - the values to set

setcell2d

public void setcell2d(int x,
                      int y,
                      double[] vals)
sets the values of a cell in a two-dimensional matrix
Parameters:
x - the x index of the cell
y - the y index of the cell
vals - the values to set

setcell3d

public void setcell3d(int x,
                      int y,
                      int z,
                      int[] vals)
sets the values of a cell in a three-dimensional matrix
Parameters:
x - the x index of the cell
y - the y index of the cell
z - the z index of the cell
vals - the values to set

setcell3d

public void setcell3d(int x,
                      int y,
                      int z,
                      float[] vals)
sets the values of a cell in a three-dimensional matrix
Parameters:
x - the x index of the cell
y - the y index of the cell
z - the z index of the cell
vals - the values to set

setcell3d

public void setcell3d(int x,
                      int y,
                      int z,
                      double[] vals)
sets the values of a cell in a three-dimensional matrix
Parameters:
x - the x index of the cell
y - the y index of the cell
z - the z index of the cell
vals - the values to set

setinfo

public void setinfo(java.lang.String matrixname)
sends a setinfo message, which sets the matrix dimensions to those of the argument matrix
Parameters:
matrixname - the name of the matrix

setinfo

public void setinfo(JitterMatrix matrix)
sends a setinfo message, which sets the matrix dimensions to those of the argument matrix
Parameters:
matrix - the JitterMatrix

write

public com.cycling74.max.Atom[] write()
sends a write message to save the matrix to disk
Returns:
nada

write

public com.cycling74.max.Atom[] write(java.lang.String filename)
sends a write message to save the matrix to disk
Parameters:
filename - the filename to write
Returns:
nada

write

public com.cycling74.max.Atom[] write(com.cycling74.max.Atom[] args)
sends a write message to save the matrix to disk
Parameters:
args - arguments to send with the message
Returns:
nada

copyVectorToArray

public int copyVectorToArray(int dim,
                             int[] offset,
                             int[] array,
                             int count,
                             int arrayoffset)
copies a vector from the JitterMatrix to an integer array
Parameters:
dim - the dimension of the vector to copy
offset - the offset into the matrix to start copying from
array - the array into which the values will be placed
count - the number of values to copy
arrayoffset - where in the array to start placing the values
Returns:
the number of values copied

copyVectorToArray

public int copyVectorToArray(int dim,
                             int[] offset,
                             float[] array,
                             int count,
                             int arrayoffset)
copies a vector from the JitterMatrix to a float array
Parameters:
dim - the dimension of the vector to copy
offset - the offset into the matrix to start copying from
array - the array into which the values will be placed
count - the number of values to copy
arrayoffset - where in the array to start placing the values
Returns:
the number of values copied

copyVectorToArray

public int copyVectorToArray(int dim,
                             int[] offset,
                             double[] array,
                             int count,
                             int arrayoffset)
copies a vector from the JitterMatrix to a double array
Parameters:
dim - the dimension of the vector to copy
offset - the offset into the matrix to start copying from
array - the array into which the values will be placed
count - the number of values to copy
arrayoffset - where in the array to start placing the values
Returns:
the number of values copied

copyVectorToArrayPlanar

public int copyVectorToArrayPlanar(int plane,
                                   int dim,
                                   int[] offset,
                                   int[] array,
                                   int count,
                                   int arrayoffset)
copies a single plane from a vector from the JitterMatrix to an integer array
Parameters:
plane - the plane to copy
dim - the dimension of the vector to copy
offset - the offset into the matrix to start copying from
array - the array into which the values will be placed
count - the number of values to copy
arrayoffset - where in the array to start placing the values
Returns:
the number of values copied

copyVectorToArrayPlanar

public int copyVectorToArrayPlanar(int plane,
                                   int dim,
                                   int[] offset,
                                   float[] array,
                                   int count,
                                   int arrayoffset)
copies a single plane from a vector from the JitterMatrix to a float array
Parameters:
plane - the plane to copy
dim - the dimension of the vector to copy
offset - the offset into the matrix to start copying from
array - the array into which the values will be placed
count - the number of values to copy
arrayoffset - where in the array to start placing the values
Returns:
the number of values copied

copyVectorToArrayPlanar

public int copyVectorToArrayPlanar(int plane,
                                   int dim,
                                   int[] offset,
                                   double[] array,
                                   int count,
                                   int arrayoffset)
copies a single plane from a vector from the JitterMatrix to a double array
Parameters:
plane - the plane to copy
dim - the dimension of the vector to copy
offset - the offset into the matrix to start copying from
array - the array into which the values will be placed
count - the number of values to copy
arrayoffset - where in the array to start placing the values
Returns:
the number of values copied

copyArrayToVector

public int copyArrayToVector(int dim,
                             int[] offset,
                             int[] array,
                             int count,
                             int arrayoffset)
copies an integer array to a vector in the JitterMatrix
Parameters:
dim - the dimension of the destination vector
offset - the offset into the destination matrix
array - the array from which the values will be copied
count - the number of values to copy
arrayoffset - where in the array to start copying the values
Returns:
the number of values copied

copyArrayToVector

public int copyArrayToVector(int dim,
                             int[] offset,
                             float[] array,
                             int count,
                             int arrayoffset)
copies a float array to a vector in the JitterMatrix
Parameters:
dim - the dimension of the destination vector
offset - the offset into the destination matrix
array - the array from which the values will be copied
count - the number of values to copy
arrayoffset - where in the array to start copying the values
Returns:
the number of values copied

copyArrayToVector

public int copyArrayToVector(int dim,
                             int[] offset,
                             double[] array,
                             int count,
                             int arrayoffset)
copies a double array to a vector in the JitterMatrix
Parameters:
dim - the dimension of the destination vector
offset - the offset into the destination matrix
array - the array from which the values will be copied
count - the number of values to copy
arrayoffset - where in the array to start copying the values
Returns:
the number of values copied

copyArrayToVectorPlanar

public int copyArrayToVectorPlanar(int plane,
                                   int dim,
                                   int[] offset,
                                   int[] array,
                                   int count,
                                   int arrayoffset)
copies an integer array to a single plane in a vector in the JitterMatrix
Parameters:
plane - the destination plane
dim - the dimension of the destination vector
offset - the offset into the destination matrix
array - the array from which the values will be copied
count - the number of values to copy
arrayoffset - where in the array to start copying the values
Returns:
the number of values copied

copyArrayToVectorPlanar

public int copyArrayToVectorPlanar(int plane,
                                   int dim,
                                   int[] offset,
                                   float[] array,
                                   int count,
                                   int arrayoffset)
copies a float array to a single plane in a vector in the JitterMatrix
Parameters:
plane - the destination plane
dim - the dimension of the destination vector
offset - the offset into the destination matrix
array - the array from which the values will be copied
count - the number of values to copy
arrayoffset - where in the array to start copying the values
Returns:
the number of values copied

copyArrayToVectorPlanar

public int copyArrayToVectorPlanar(int plane,
                                   int dim,
                                   int[] offset,
                                   double[] array,
                                   int count,
                                   int arrayoffset)
copies a double array to a single plane in a vector in the JitterMatrix
Parameters:
plane - the destination plane
dim - the dimension of the destination vector
offset - the offset into the destination matrix
array - the array from which the values will be copied
count - the number of values to copy
arrayoffset - where in the array to start copying the values
Returns:
the number of values copied