Object Module
[Jitter]

Collaboration diagram for Object Module:

Functions
long	jit_object_classname_compare (void *x, t_symbol *name)
	Compares object's class name with the name provided.
t_symbol *	jit_object_method_argsafe_get (void *x, t_symbol *s)
	Checks to see if symbol is safe to call as an attribute style argument.
void *	jit_object_new (t_symbol *classname,...)
	Instantiates an object specified by class name.
void *	jit_object_method (void *x, t_symbol *s,...)
	Calls an object method specified by method name.
void *	jit_object_method_typed (void *x, t_symbol *s, long ac, t_atom *av, t_atom *rv)
	Calls a typed object method specified by method name.
method	jit_object_getmethod (void *x, t_symbol *s)
	Retrieves an object method specified by method name.
long	jit_object_attr_usercanset (void *x, t_symbol *s)
	Determines if an object attribute is user settable.
long	jit_object_attr_usercanget (void *x, t_symbol *s)
	Determines if an object attribute is user gettable.
void *	jit_object_attr_get (void *x, t_symbol *attrname)
	Retrieves an object's attribute pointer specified by attribute name.
t_jit_err	jit_object_free (void *x)
	Frees an object.
t_symbol *	jit_object_classname (void *x)
	Retrieves an object's class name.
void *	jit_object_class (void *x)
	Retrieves an object's class pointer.
void *	jit_object_register (void *x, t_symbol *s)
	Registers an object in the named object registry.
t_jit_err	jit_object_unregister (void *x)
	Unregisters an object from the named object registry.
void *	jit_object_findregistered (t_symbol *s)
	Retrieves a registered object associated with name.
t_symbol *	jit_object_findregisteredbyptr (void *x)
	Retrieves a registered object's name.
void *	jit_object_attach (t_symbol *s, void *x)
	Attaches an object as a client of a named server object for notification.
t_jit_err	jit_object_detach (t_symbol *s, void *x)
	Detaches a client object from a named server object.
t_jit_err	jit_object_notify (void *x, t_symbol *s, void *data)
	Notifies all client objects for a named server object.
t_jit_err	jit_object_importattrs (void *x, t_symbol *s, long argc, t_atom *argv)
	Imports object attributes from an XML file.
t_jit_err	jit_object_exportattrs (void *x, t_symbol *s, long argc, t_atom *argv)
	Exports object attributes to an XML file.
t_jit_err	jit_object_exportsummary (void *x, t_symbol *s, long argc, t_atom *argv)
	Exports object summary to an XML file.

---

Function Documentation

void* jit_object_attach	(	t_symbol *	s,
		void *	x
	)

Attaches an object as a client of a named server object for notification.

Parameters:

	s	name of server object
	x	client object pointer

Returns:

If successful, server object pointer. Otherwise NULL.

Definition at line 1821 of file jit.foundation.c.

References object_attach().

Referenced by jit_qt_record_matrix_calc(), max_jit_mop_inputs(), max_jit_mop_notify(), max_jit_mop_outputs(), and max_jit_ob3d_attach().

Here is the call graph for this function:

void* jit_object_attr_get	(	void *	x,
		t_symbol *	attrname
	)

Retrieves an object's attribute pointer specified by attribute name.

Parameters:

	x	object pointer
	attrname	attribute name

Returns:

attribute object pointer

Definition at line 1574 of file jit.foundation.c.

References object_attr_get().

Here is the call graph for this function:

long jit_object_attr_usercanget	(	void *	x,
		t_symbol *	s
	)

Determines if an object attribute is user gettable.

Parameters:

	x	object pointer
	s	attribute name

Returns:

1 if gettable, 0 if not gettable

Definition at line 1558 of file jit.foundation.c.

References object_attr_usercanget().

Here is the call graph for this function:

long jit_object_attr_usercanset	(	void *	x,
		t_symbol *	s
	)

Determines if an object attribute is user settable.

Parameters:

	x	object pointer
	s	attribute name

Returns:

1 if settable, 0 if not settable

Definition at line 1542 of file jit.foundation.c.

References object_attr_usercanset().

Referenced by max_jit_attr_args().

Here is the call graph for this function:

void* jit_object_class

(

void *

x

)

Retrieves an object's class pointer.

Parameters:

x

object pointer

Returns:

class pointer

Definition at line 1621 of file jit.foundation.c.

References object_class().

Referenced by jit_object_method_argsafe_get(), and max_jit_mop_setup().

Here is the call graph for this function:

t_symbol* jit_object_classname

(

void *

x

)

Retrieves an object's class name.

Parameters:

x

object pointer

Returns:

class name t_symbol pointer

Definition at line 1606 of file jit.foundation.c.

References object_classname().

Referenced by jit_object_classname_compare(), and jit_object_exportattrs().

Here is the call graph for this function:

long jit_object_classname_compare	(	void *	x,
		t_symbol *	name
	)

Compares object's class name with the name provided.

Parameters:

	x	object pointer
	name	name to compare with class name

Returns:

1 if equal, 0 if not equal

Definition at line 1116 of file jit.foundation.c.

References jit_object_classname().

Referenced by max_jit_obex_adornment_get().

Here is the call graph for this function:

t_jit_err jit_object_detach	(	t_symbol *	s,
		void *	x
	)

Detaches a client object from a named server object.

Parameters:

	s	name of server object
	x	client object pointer

Returns:

t_jit_err error code

Definition at line 1837 of file jit.foundation.c.

References jit_err_from_max_err(), and object_detach().

Referenced by max_jit_mop_free(), and max_jit_ob3d_detach().

Here is the call graph for this function:

t_jit_err jit_object_exportattrs	(	void *	x,
		t_symbol *	s,
		long	argc,
		t_atom *	argv
	)

Exports object attributes to an XML file.

Parameters:

	x	object pointer
	s	ignored
	argc	argument count
	argv	argument vector

Returns:

t_jit_err error code

Definition at line 1939 of file jit.foundation.c.

References freebytes(), gensym(), jit_atom_setsym(), jit_object_classname(), jit_object_free(), jit_object_method(), object_attr_get(), t_symbol::s_name, and symbolarray_sort().

Referenced by jit_class_new(), and max_jit_classex_standard_wrap().

Here is the call graph for this function:

t_jit_err jit_object_exportsummary	(	void *	x,
		t_symbol *	s,
		long	argc,
		t_atom *	argv
	)

Exports object summary to an XML file.

Warning:

Currently this function does nothing, but is reserved for future use.

Parameters:

	x	object pointer
	s	ignored
	argc	argument count
	argv	argument vector

Returns:

t_jit_err error code

Definition at line 2020 of file jit.foundation.c.

Referenced by max_jit_classex_standard_wrap().

void * jit_object_findregistered

(

t_symbol *

s

)

Retrieves a registered object associated with name.

Parameters:

s

registered name

Returns:

If successful, object pointer. Otherwise NULL.

Definition at line 1785 of file jit.foundation.c.

Referenced by jit_matrix_jit_gl_texture(), jit_matrix_op(), jit_qt_movie_matrix_calc(), max_jit_mop_jit_matrix(), and max_jit_mop_notify().

t_symbol* jit_object_findregisteredbyptr

(

void *

x

)

Retrieves a registered object's name.

Parameters:

x

object pointer

Returns:

If successful, t_symbol pointer name. Otherwise NULL.

Definition at line 1800 of file jit.foundation.c.

References object_findregisteredbyptr().

Referenced by jit_qt_record_matrix_calc().

Here is the call graph for this function:

t_jit_err jit_object_free

(

void *

x

)

Frees an object.

Parameters:

x

object pointer

Returns:

t_jit_err error code

Definition at line 1589 of file jit.foundation.c.

References jit_err_from_max_err(), and object_free().

Referenced by jit_glchunk_delete(), jit_linklist_chuck(), jit_matrix_exprfill(), jit_matrix_new(), jit_matrix_newcopy(), jit_matrix_op(), jit_mop_free(), jit_mop_new(), jit_mop_newcopy(), jit_object_exportattrs(), jit_object_importattrs(), jit_qt_utils_tempfile(), max_jit_mop_adapt_matrix_all(), max_jit_mop_free(), and max_jit_obex_free().

Here is the call graph for this function:

method jit_object_getmethod	(	void *	x,
		t_symbol *	s
	)

Retrieves an object method specified by method name.

Parameters:

	x	object pointer
	s	method name

Returns:

method

Definition at line 1526 of file jit.foundation.c.

References object_getmethod().

Referenced by jit_attr_filterget(), jit_attr_filterset(), and jit_ob3d_new().

Here is the call graph for this function:

t_jit_err jit_object_importattrs	(	void *	x,
		t_symbol *	s,
		long	argc,
		t_atom *	argv
	)

Imports object attributes from an XML file.

Parameters:

	x	object pointer
	s	ignored
	argc	argument count
	argv	argument vector

Returns:

t_jit_err error code

Definition at line 1883 of file jit.foundation.c.

References freebytes(), gensym(), jit_linklist_chuck(), jit_linklist_getindex(), jit_linklist_getsize(), jit_object_free(), and object_attr_setvalueof().

Referenced by jit_class_new(), and max_jit_classex_standard_wrap().

Here is the call graph for this function:

void * jit_object_method	(	void *	x,
		t_symbol *	s,
			...
	)

Calls an object method specified by method name.

This operation is untyped, and the contents of the stack following the method name argument are blindly passed to the method called.

Parameters:

	x	object pointer
	s	method name
	...	untyped arguments passed on to the method

Warning:

It is important to know any necessary arguments for untyped constructors such as those used by jit_matrix or jit_attr_offset.

Returns:

method dependent, but uses void * as a super type.

Definition at line 1489 of file jit.foundation.c.

Referenced by jit_bin_read_matrix(), jit_bin_write_matrix(), jit_coerce_matrix_pixmap(), jit_glchunk_copy(), jit_gworld_can_coerce_matrix(), jit_gworld_matrix_equal_dim(), jit_linklist_methodall(), jit_linklist_methodindex(), jit_matrix_exprfill(), jit_matrix_frommatrix(), jit_matrix_jit_gl_texture(), jit_matrix_op(), jit_mop_getinput(), jit_mop_getoutput(), jit_mop_input_nolink(), jit_mop_ioproc_copy_adapt(), jit_mop_ioproc_copy_trunc(), jit_mop_ioproc_copy_trunc_zero(), jit_mop_methodall(), jit_mop_new(), jit_mop_newcopy(), jit_mop_output_nolink(), jit_mop_single_planecount(), jit_mop_single_type(), jit_ob3d_draw_chunk(), jit_ob3d_new(), jit_ob3d_set_context(), jit_object_exportattrs(), jit_qt_movie_matrix_calc(), jit_qt_movie_matrix_to_image(), jit_qt_record_matrix_calc(), jit_qt_utils_tempfile(), max_jit_attr_args(), max_jit_attr_get(), max_jit_attr_set(), max_jit_classex_addattr(), max_jit_classex_mop_mproc(), max_jit_classex_mop_wrap(), max_jit_mop_adapt_matrix_all(), max_jit_mop_assist(), max_jit_mop_clear(), max_jit_mop_free(), max_jit_mop_get_io_by_name(), max_jit_mop_getinput(), max_jit_mop_getoutput(), max_jit_mop_inputs(), max_jit_mop_jit_matrix(), max_jit_mop_matrix_args(), max_jit_mop_matrixout_new(), max_jit_mop_notify(), max_jit_mop_outputmatrix(), max_jit_mop_outputs(), max_jit_mop_setup(), max_jit_mop_variable_addinputs(), max_jit_mop_variable_addoutputs(), max_jit_ob3d_attach(), max_jit_obex_adornment_get(), max_jit_obex_attr_get(), max_jit_obex_attr_set(), and max_ob3d_notify().

t_symbol* jit_object_method_argsafe_get	(	void *	x,
		t_symbol *	s
	)

Checks to see if symbol is safe to call as an attribute style argument.

Parameters:

	x	object pointer
	s	name as used via argument

Returns:

If successful, name of method to map the argument name to. Otherwise, NULL.

Definition at line 1393 of file jit.foundation.c.

References jit_class_method_argsafe_get(), and jit_object_class().

Referenced by max_jit_attr_args().

Here is the call graph for this function:

void* jit_object_method_typed	(	void *	x,
		t_symbol *	s,
		long	ac,
		t_atom *	av,
		t_atom *	rv
	)

Calls a typed object method specified by method name.

This operation only supports methods which are typed--i.e. it cannot be used to call private, untyped A_CANT methods.

Parameters:

	x	object pointer
	s	method name
	ac	argument count
	av	argument vector
	rv	return value for A_GIMMEBACK methods

Returns:

method dependent, but uses void * as a super type.

Definition at line 1510 of file jit.foundation.c.

References object_method_typed().

Here is the call graph for this function:

void * jit_object_new	(	t_symbol *	classname,
			...
	)

Instantiates an object specified by class name.

This function may used to create instances of any Jitter object.

Parameters:

	classname	class name
	...	untyped arguments passed on to the constructor

Warning:

It is important to know any necessary arguments for untyped constructors such as those used by jit_matrix or jit_attr_offset.

Returns:

If successful, a valid object pointer. Otherwise, NULL.

Definition at line 1443 of file jit.foundation.c.

Referenced by jit_glchunk_copy(), jit_glchunk_grid_new(), jit_glchunk_new(), jit_matrix_exprfill(), jit_matrix_op(), jit_mop_new(), jit_mop_newcopy(), jit_ob3d_setup(), jit_qt_movie_new(), jit_qt_record_new(), jit_qt_utils_tempfile(), max_jit_classex_mop_wrap(), max_jit_mop_adapt_matrix_all(), max_jit_mop_inputs(), max_jit_mop_notify(), and max_jit_mop_outputs().

t_jit_err jit_object_notify	(	void *	x,
		t_symbol *	s,
		void *	data
	)

Notifies all client objects for a named server object.

Parameters:

	x	server object pointer
	s	notification message
	data	message specific data

Returns:

t_jit_err error code

Definition at line 1856 of file jit.foundation.c.

References object_notify().

Referenced by jit_matrix_setinfo(), jit_matrix_setinfo_ex(), jit_ob3d_draw_chunk(), and jit_qt_record_matrix_calc().

Here is the call graph for this function:

void* jit_object_register	(	void *	x,
		t_symbol *	s
	)

Registers an object in the named object registry.

Parameters:

	x	object pointer
	s	object name

Returns:

object pointer

Warning:

It is important to use the object pointer returned by jit_object_register, since if there is an existing object with the same name and class, it could free the input object and pass back a reference to the previously defined object.

Definition at line 1751 of file jit.foundation.c.

References object_register().

Referenced by max_jit_mop_inputs(), max_jit_mop_notify(), and max_jit_mop_outputs().

Here is the call graph for this function:

t_jit_err jit_object_unregister

(

void *

x

)

Unregisters an object from the named object registry.

Parameters:

x

object pointer

Returns:

t_jit_err error code

Definition at line 1767 of file jit.foundation.c.

References jit_err_from_max_err(), and object_unregister().

Here is the call graph for this function: