Max 5 API Reference

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.
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
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
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
void* jit_object_class ( void *  x  ) 

Retrieves an object's class pointer.

Parameters:
x object pointer
Returns:
class pointer
t_symbol* jit_object_classname ( void *  x  ) 

Retrieves an object's class name.

Parameters:
x object pointer
Returns:
class name t_symbol pointer
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
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
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
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
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.
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.
t_jit_err jit_object_free ( void *  x  ) 

Frees an object.

Parameters:
x object pointer
Returns:
t_jit_err error code
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
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
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.
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.
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.
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.
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
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.
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

Copyright © 2008, Cycling '74