An attribute of an object is a setting or property that tells the object how to do its job. More...

Data Structures
struct	t_attr
	Common attr struct. More...

Macros
#define	CLASS_ATTR_CHAR(c, attrname, flags, structname, structmember)
	Create a char attribute and add it to a Max class. More...

#define	CLASS_ATTR_LONG(c, attrname, flags, structname, structmember)
	Create a t_atom_long integer attribute and add it to a Max class. More...

#define	CLASS_ATTR_ATOM_LONG(c, attrname, flags, structname, structmember)
	Create a t_atom_long integer attribute and add it to a Max class. More...

#define	CLASS_ATTR_INT32(c, attrname, flags, structname, structmember)
	Create a t_int32 integer attribute and add it to a Max class. More...

#define	CLASS_ATTR_FLOAT(c, attrname, flags, structname, structmember)
	Create a 32-bit float attribute and add it to a Max class. More...

#define	CLASS_ATTR_DOUBLE(c, attrname, flags, structname, structmember)
	Create a 64-bit float attribute and add it to a Max class. More...

#define	CLASS_ATTR_SYM(c, attrname, flags, structname, structmember)
	Create a t_symbol* attribute and add it to a Max class. More...

#define	CLASS_ATTR_ATOM(c, attrname, flags, structname, structmember)
	Create a t_atom attribute and add it to a Max class. More...

#define	CLASS_ATTR_OBJ(c, attrname, flags, structname, structmember)
	Create a t_object* attribute and add it to a Max class. More...

#define	CLASS_ATTR_CHAR_ARRAY(c, attrname, flags, structname, structmember, size)
	Create an array-of-chars attribute of fixed length, and add it to a Max class. More...

#define	CLASS_ATTR_LONG_ARRAY(c, attrname, flags, structname, structmember, size)
	Create an array-of-long-integers attribute of fixed length, and add it to a Max class. More...

#define	CLASS_ATTR_ATOM_LONG_ARRAY(c, attrname, flags, structname, structmember, size)
	Create an array-of-t_atom_long-integers attribute of fixed length, and add it to a Max class. More...

#define	CLASS_ATTR_FLOAT_ARRAY(c, attrname, flags, structname, structmember, size)
	Create an array-of-32bit-floats attribute of fixed length, and add it to a Max class. More...

#define	CLASS_ATTR_DOUBLE_ARRAY(c, attrname, flags, structname, structmember, size)
	Create an array-of-64bit-floats attribute of fixed length, and add it to a Max class. More...

#define	CLASS_ATTR_SYM_ARRAY(c, attrname, flags, structname, structmember, size)
	Create an array-of-symbols attribute of fixed length, and add it to a Max class. More...

#define	CLASS_ATTR_ATOM_ARRAY(c, attrname, flags, structname, structmember, size)
	Create an array-of-atoms attribute of fixed length, and add it to a Max class. More...

#define	CLASS_ATTR_OBJ_ARRAY(c, attrname, flags, structname, structmember, size)
	Create an array-of-objects attribute of fixed length, and add it to a Max class. More...

#define	CLASS_ATTR_CHAR_VARSIZE(c, attrname, flags, structname, structmember, sizemember, maxsize)
	Create an array-of-chars attribute of variable length, and add it to a Max class. More...

#define	CLASS_ATTR_LONG_VARSIZE(c, attrname, flags, structname, structmember, sizemember, maxsize)
	Create an array-of-long-integers attribute of variable length, and add it to a Max class. More...

#define	CLASS_ATTR_FLOAT_VARSIZE(c, attrname, flags, structname, structmember, sizemember, maxsize)
	Create an array-of-32bit-floats attribute of variable length, and add it to a Max class. More...

#define	CLASS_ATTR_DOUBLE_VARSIZE(c, attrname, flags, structname, structmember, sizemember, maxsize)
	Create an array-of-64bit-floats attribute of variable length, and add it to a Max class. More...

#define	CLASS_ATTR_SYM_VARSIZE(c, attrname, flags, structname, structmember, sizemember, maxsize)
	Create an array-of-symbols attribute of variable length, and add it to a Max class. More...

#define	CLASS_ATTR_ATOM_VARSIZE(c, attrname, flags, structname, structmember, sizemember, maxsize)
	Create an array-of-atoms attribute of variable length, and add it to a Max class. More...

#define	CLASS_ATTR_OBJ_VARSIZE(c, attrname, flags, structname, structmember, sizemember, maxsize)
	Create an array-of-objects attribute of variable length, and add it to a Max class. More...

#define	STRUCT_ATTR_CHAR(c, flags, structname, structmember)
	Create a char attribute and add it to a Max class. More...

#define	STRUCT_ATTR_LONG(c, flags, structname, structmember)
	Create a long integer attribute and add it to a Max class. More...

#define	STRUCT_ATTR_ATOM_LONG(c, flags, structname, structmember)
	Create a t_atom_long integer attribute and add it to a Max class. More...

#define	STRUCT_ATTR_FLOAT(c, flags, structname, structmember)
	Create a 32bit float attribute and add it to a Max class. More...

#define	STRUCT_ATTR_DOUBLE(c, flags, structname, structmember)
	Create a 64bit float attribute and add it to a Max class. More...

#define	STRUCT_ATTR_SYM(c, flags, structname, structmember)
	Create a t_symbol* attribute and add it to a Max class. More...

#define	STRUCT_ATTR_ATOM(c, flags, structname, structmember)
	Create a t_atom attribute and add it to a Max class. More...

#define	STRUCT_ATTR_OBJ(c, flags, structname, structmember)
	Create a t_object* attribute and add it to a Max class. More...

#define	STRUCT_ATTR_CHAR_ARRAY(c, flags, structname, structmember, size)
	Create an array-of-chars attribute of fixed length, and add it to a Max class. More...

#define	STRUCT_ATTR_LONG_ARRAY(c, flags, structname, structmember, size)
	Create an array-of-long-integers attribute of fixed length, and add it to a Max class. More...

#define	STRUCT_ATTR_FLOAT_ARRAY(c, flags, structname, structmember, size)
	Create an array-of-32bit-floats attribute of fixed length, and add it to a Max class. More...

#define	STRUCT_ATTR_DOUBLE_ARRAY(c, flags, structname, structmember, size)
	Create an array-of-64bit-floats attribute of fixed length, and add it to a Max class. More...

#define	STRUCT_ATTR_SYM_ARRAY(c, flags, structname, structmember, size)
	Create an array-of-symbols attribute of fixed length, and add it to a Max class. More...

#define	STRUCT_ATTR_ATOM_ARRAY(c, flags, structname, structmember, size)
	Create an array-of-atoms attribute of fixed length, and add it to a Max class. More...

#define	STRUCT_ATTR_OBJ_ARRAY(c, flags, structname, structmember, size)
	Create an array-of-objects attribute of fixed length, and add it to a Max class. More...

#define	STRUCT_ATTR_CHAR_VARSIZE(c, flags, structname, structmember, sizemember, maxsize)
	Create an array-of-chars attribute of variable length, and add it to a Max class. More...

#define	STRUCT_ATTR_LONG_VARSIZE(c, flags, structname, structmember, sizemember, maxsize)
	Create an array-of-long-integers attribute of variable length, and add it to a Max class. More...

#define	STRUCT_ATTR_FLOAT_VARSIZE(c, flags, structname, structmember, sizemember, maxsize)
	Create an array-of-32bit-floats attribute of variable length, and add it to a Max class. More...

#define	STRUCT_ATTR_DOUBLE_VARSIZE(c, flags, structname, structmember, sizemember, maxsize)
	Create an array-of-64bit-floats attribute of variable length, and add it to a Max class. More...

#define	STRUCT_ATTR_SYM_VARSIZE(c, flags, structname, structmember, sizemember, maxsize)
	Create an array-of-symbols attribute of variable length, and add it to a Max class. More...

#define	STRUCT_ATTR_ATOM_VARSIZE(c, flags, structname, structmember, sizemember, maxsize)
	Create an array-of-atoms attribute of variable length, and add it to a Max class. More...

#define	STRUCT_ATTR_OBJ_VARSIZE(c, flags, structname, structmember, sizemember, maxsize)
	Create an array-of-objects attribute of variable length, and add it to a Max class. More...

#define	OBJ_ATTR_CHAR(x, attrname, flags, val)
	Create an instance-local char attribute and add it to a Max class. More...

#define	OBJ_ATTR_LONG(x, attrname, flags, val)
	Create an instance-local long integer attribute and add it to a Max class. More...

#define	OBJ_ATTR_FLOAT(x, attrname, flags, val)
	Create an instance-local 32bit float attribute and add it to a Max class. More...

#define	OBJ_ATTR_DOUBLE(x, attrname, flags, val)
	Create an instance-local 64bit float attribute and add it to a Max class. More...

#define	OBJ_ATTR_SYM(x, attrname, flags, val)
	Create an instance-local t_symbol* attribute and add it to a Max class. More...

#define	OBJ_ATTR_ATOM(x, attrname, flags, val)
	Create an instance-local t_atom attribute and add it to a Max class. More...

#define	OBJ_ATTR_OBJ(x, attrname, flags, val)
	Create an instance-local t_object* attribute and add it to a Max class. More...

#define	OBJ_ATTR_CHAR_ARRAY(x, attrname, flags, count, vals)
	Create an instance-local array-of-chars attribute of fixed length, and add it to the object. More...

#define	OBJ_ATTR_LONG_ARRAY(x, attrname, flags, count, vals)
	Create an instance-local array-of-long-integers attribute of fixed length, and add it to the object. More...

#define	OBJ_ATTR_FLOAT_ARRAY(x, attrname, flags, count, vals)
	Create an instance-local array-of-32bit-floats attribute of fixed length, and add it to the object. More...

#define	OBJ_ATTR_DOUBLE_ARRAY(x, attrname, flags, count, vals)
	Create an instance-local array-of-64bit-floats attribute of fixed length, and add it to the object. More...

#define	OBJ_ATTR_SYM_ARRAY(x, attrname, flags, count, vals)
	Create an instance-local array-of-symbols attribute of fixed length, and add it to the object. More...

#define	OBJ_ATTR_ATOM_ARRAY
	Create an instance-local array-of-atoms attribute of fixed length, and add it to the object. More...

#define	OBJ_ATTR_OBJ_ARRAY(x, attrname, flags, count, vals)
	Create an instance-local array-of-objects attribute of fixed length, and add it to the object. More...

#define	CLASS_ATTR_ACCESSORS(c, attrname, getter, setter)
	Specify custom accessor methods for an attribute. More...

#define	CLASS_ATTR_ADD_FLAGS(c, attrname, flags)
	Add flags to an attribute. More...

#define	CLASS_ATTR_REMOVE_FLAGS(c, attrname, flags)
	Remove flags from an attribute. More...

#define	CLASS_ATTR_FILTER_MIN(c, attrname, minval)
	Add a filter to the attribute to limit the lower bound of a value. More...

#define	CLASS_ATTR_FILTER_MAX(c, attrname, maxval)
	Add a filter to the attribute to limit the upper bound of a value. More...

#define	CLASS_ATTR_FILTER_CLIP(c, attrname, minval, maxval)
	Add a filter to the attribute to limit both the lower and upper bounds of a value. More...

#define	CLASS_ATTR_ALIAS(c, attrname, aliasname)
	Create a new attribute that is an alias of an existing attribute. More...

#define	CLASS_ATTR_DEFAULT(c, attrname, flags, parsestr)
	Add a new attribute to the specified attribute to specify a default value. More...

#define	CLASS_ATTR_SAVE(c, attrname, flags)
	Add a new attribute to the specified attribute to indicate that the specified attribute should be saved with the patcher. More...

#define	CLASS_ATTR_SELFSAVE(c, attrname, flags)
	Add a new attribute to the specified attribute to indicate that it is saved by the object (so it does not appear in italics in the inspector). More...

#define	CLASS_ATTR_DEFAULT_SAVE(c, attrname, flags, parsestr)
	A convenience wrapper for both CLASS_ATTR_DEFAULT and CLASS_ATTR_SAVE. More...

#define	CLASS_ATTR_DEFAULTNAME(c, attrname, flags, parsestr)
	Add a new attribute to the specified attribute to specify a default value, based on Max's Object Defaults. More...

#define	CLASS_ATTR_DEFAULTNAME_SAVE(c, attrname, flags, parsestr)
	A convenience wrapper for both CLASS_ATTR_DEFAULTNAME and CLASS_ATTR_SAVE. More...

#define	CLASS_ATTR_MIN(c, attrname, flags, parsestr)
	Add a new attribute to the specified attribute to specify a lower range. More...

#define	CLASS_ATTR_MAX(c, attrname, flags, parsestr)
	Add a new attribute to the specified attribute to specify an upper range. More...

#define	CLASS_ATTR_PAINT(c, attrname, flags)
	Add a new attribute indicating that any changes to the specified attribute will trigger a call to the object's paint method. More...

#define	CLASS_ATTR_DEFAULT_PAINT(c, attrname, flags, parsestr)
	A convenience wrapper for both CLASS_ATTR_DEFAULT and CLASS_ATTR_PAINT. More...

#define	CLASS_ATTR_DEFAULT_SAVE_PAINT(c, attrname, flags, parsestr)
	A convenience wrapper for CLASS_ATTR_DEFAULT, CLASS_ATTR_SAVE, and CLASS_ATTR_PAINT. More...

#define	CLASS_ATTR_DEFAULTNAME_PAINT(c, attrname, flags, parsestr)
	A convenience wrapper for CLASS_ATTR_DEFAULTNAME, CLASS_ATTR_SAVE, and CLASS_ATTR_PAINT. More...

#define	CLASS_ATTR_DEFAULTNAME_SAVE_PAINT(c, attrname, flags, parsestr)
	A convenience wrapper for CLASS_ATTR_DEFAULTNAME, CLASS_ATTR_SAVE, and CLASS_ATTR_PAINT. More...

#define	CLASS_ATTR_STYLE(c, attrname, flags, parsestr)
	Add a new attribute to the specified attribute to specify an editor style for the Max inspector. More...

#define	CLASS_ATTR_LABEL(c, attrname, flags, labelstr)
	Add a new attribute to the specified attribute to specify an a human-friendly label for the Max inspector. More...

#define	CLASS_ATTR_ENUM(c, attrname, flags, parsestr)
	Add a new attribute to the specified attribute to specify a list of choices to display in a menu for the Max inspector. More...

#define	CLASS_ATTR_ENUMINDEX(c, attrname, flags, parsestr)
	Add a new attribute to the specified attribute to specify a list of choices to display in a menu for the Max inspector. More...

#define	CLASS_ATTR_CATEGORY(c, attrname, flags, parsestr)
	Add a new attribute to the specified attribute to specify a category to which the attribute is assigned in the Max inspector. More...

#define	CLASS_ATTR_STYLE_LABEL(c, attrname, flags, stylestr, labelstr)
	A convenience wrapper for CLASS_ATTR_STYLE, and CLASS_ATTR_LABEL. More...

#define	CLASS_ATTR_INVISIBLE(c, attrname, flags)
	Add a new attribute to the specified attribute to flag an attribute as invisible to the Max inspector. More...

#define	CLASS_ATTR_ORDER(c, attrname, flags, parsestr)
	Add a new attribute to the specified attribute to specify a default order in which to list attributes. More...

#define	CLASS_ATTR_BASIC(c, attrname, flags)
	Add a new attribute to the specified attribute to specify that it should appear in the inspector's Basic tab. More...

#define	CLASS_METHOD_ATTR_PARSE(c, methodname, attrname, type, flags, parsestring)
	Define and add attributes to class methods. More...

#define	CLASS_ATTR_LEGACYDEFAULT(c, legacyattrname, newattrname, flags, parsestr)
	Add a new attribute to the specified attribute to specify a legacy default value. More...

#define	CLASS_ATTR_OBSOLETE(c, attrname, flags)
	Add a new attribute to the specified attribute to flag it as obsolete. More...

#define	CLASS_ATTR_RENAMED(c, oldname, newname, flags)
	Add a new attribute to the specified attribute to flag it as renamed. More...

#define	CLASS_ATTR_INTRODUCED(c, attrname, flags, versionstr)
	Add a new attribute to the specified attribute to indicate in which version the attribute was introduced. More...

#define	CLASS_METHOD_OBSOLETE(c, methodname, flags)
	Add a new attribute to the specified method to flag it as obsolete. More...

#define	CLASS_METHOD_RENAMED(c, oldname, newname, flags)
	Add a new attribute to the specified method to flag a method as renamed. More...

#define	CLASS_METHOD_INTRODUCED(c, methodname, flags, versionstr)
	Add a new attribute to the specified method to indicate in which version the method was introduced. More...

#define	OBJ_ATTR_DEFAULT(x, attrname, flags, parsestr)
	An instance-attribute version of CLASS_ATTR_DEFAULT. More...

#define	OBJ_ATTR_SAVE(x, attrname, flags)
	An instance-attribute version of CLASS_ATTR_SAVE. More...

#define	OBJ_ATTR_DEFAULT_SAVE(x, attrname, flags, parsestr)
	An instance-attribute version of CLASS_ATTR_DEFAULT_SAVE. More...

#define	CLASS_STICKY_ATTR(c, name, flags, parsestr)
	Create an attribute, and add it to all following attribute declarations. More...

#define	CLASS_STICKY_ATTR_CLEAR(c, name)
	Close a CLASS_STICKY_ATTR block. More...

#define	CLASS_STICKY_METHOD(c, name, flags, parsestr)
	Create an attribute, and add it to all following method declarations. More...

#define	CLASS_STICKY_METHOD_CLEAR(c, name)
	Close a CLASS_STICKY_METHOD block. More...

#define	CLASS_ATTR_RGBA(c, attrname, flags, structname, structmember)
	Create a color (t_jrgba) attribute and add it to a Max class. More...

Enumerations
enum	e_max_attrflags { ATTR_FLAGS_NONE, ATTR_GET_OPAQUE, ATTR_SET_OPAQUE, ATTR_GET_OPAQUE_USER, ATTR_SET_OPAQUE_USER }
	Attribute flags. More...

Functions
void *	object_attr_get (void x, t_symbol attrname)
	Returns the pointer to an attribute, given its name. More...

method	object_attr_method (void x, t_symbol methodname, void *attr, long get)
	Returns the method of an attribute's `get` or `set` function, as well as a pointer to the attribute itself, from a message name. More...

long	object_attr_usercanset (void x, t_symbol s)
	Determines if an object's attribute can be set from the Max interface (i.e. More...

long	object_attr_usercanget (void x, t_symbol s)
	Determines if the value of an object's attribute can be queried from the Max interface (i.e. More...

void	object_attr_getdump (void x, t_symbol s, long argc, t_atom *argv)
	Forces a specified object's attribute to send its value from the object's dumpout outlet in the Max interface. More...

t_max_err	object_attr_setvalueof (void x, t_symbol s, long argc, t_atom *argv)
	Sets the value of an object's attribute. More...

t_max_err	object_addattr (void x, t_object attr)
	Attaches an attribute directly to an object. More...

t_max_err	object_deleteattr (void x, t_symbol attrsym)
	Detach an attribute from an object that was previously attached with object_addattr(). More...

t_max_err	object_chuckattr (void x, t_symbol attrsym)
	Detach an attribute from an object that was previously attached with object_addattr(). More...

long	attr_args_offset (short ac, t_atom *av)
	Determines the point in an atom list where attribute arguments begin. More...

void	attr_args_process (void x, short ac, t_atom av)
	Takes an atom list and properly set any attributes described within. More...

t_object *	attribute_new (C74_CONST char name, t_symbol type, long flags, method mget, method mset)
	Create a new attribute. More...

t_object *	attr_offset_new (C74_CONST char name, C74_CONST t_symbol type, long flags, C74_CONST method mget, C74_CONST method mset, long offset)
	Create a new attribute. More...

t_object *	attr_offset_array_new (C74_CONST char name, t_symbol type, long size, long flags, method mget, method mset, long offsetcount, long offset)
	Create a new attribute. More...

t_atom_long	object_attr_getlong (void x, t_symbol s)
	Retrieves the value of an attribute, given its parent object and name. More...

t_max_err	object_attr_setlong (void x, t_symbol s, t_atom_long c)
	Sets the value of an attribute, given its parent object and name. More...

t_atom_float	object_attr_getfloat (void x, t_symbol s)
	Retrieves the value of an attribute, given its parent object and name. More...

t_max_err	object_attr_setfloat (void x, t_symbol s, t_atom_float c)
	Sets the value of an attribute, given its parent object and name. More...

t_symbol *	object_attr_getsym (void x, t_symbol s)
	Retrieves the value of an attribute, given its parent object and name. More...

t_max_err	object_attr_setsym (void x, t_symbol s, t_symbol *c)
	Sets the value of an attribute, given its parent object and name. More...

long	object_attr_getlong_array (void x, t_symbol s, long max, t_atom_long *vals)
	Retrieves the value of an attribute, given its parent object and name. More...

t_max_err	object_attr_setlong_array (void x, t_symbol s, long count, t_atom_long *vals)
	Sets the value of an attribute, given its parent object and name. More...

long	object_attr_getchar_array (void x, t_symbol s, long max, t_uint8 *vals)
	Retrieves the value of an attribute, given its parent object and name. More...

t_max_err	object_attr_setchar_array (void x, t_symbol s, long count, C74_CONST t_uint8 *vals)
	Sets the value of an attribute, given its parent object and name. More...

long	object_attr_getfloat_array (void x, t_symbol s, long max, float *vals)
	Retrieves the value of an attribute, given its parent object and name. More...

t_max_err	object_attr_setfloat_array (void x, t_symbol s, long count, float *vals)
	Sets the value of an attribute, given its parent object and name. More...

long	object_attr_getdouble_array (void x, t_symbol s, long max, double *vals)
	Retrieves the value of an attribute, given its parent object and name. More...

t_max_err	object_attr_setdouble_array (void x, t_symbol s, long count, double *vals)
	Sets the value of an attribute, given its parent object and name. More...

long	object_attr_getsym_array (void x, t_symbol s, long max, t_symbol **vals)
	Retrieves the value of an attribute, given its parent object and name. More...

t_max_err	object_attr_setsym_array (void x, t_symbol s, long count, t_symbol **vals)
	Sets the value of an attribute, given its parent object and name. More...

t_max_err	attr_addfilterset_clip (void *x, double min, double max, long usemin, long usemax)
	Attaches a clip filter to an attribute. More...

t_max_err	attr_addfilterset_clip_scale (void *x, double scale, double min, double max, long usemin, long usemax)
	Attaches a clip/scale filter to an attribute. More...

t_max_err	attr_addfilterget_clip (void *x, double min, double max, long usemin, long usemax)
	Attaches a clip filter to an attribute. More...

t_max_err	attr_addfilterget_clip_scale (void *x, double scale, double min, double max, long usemin, long usemax)
	Attaches a clip/scale filter to an attribute. More...

t_max_err	attr_addfilter_clip (void *x, double min, double max, long usemin, long usemax)
	Attaches a clip filter to an attribute. More...

t_max_err	attr_addfilter_clip_scale (void *x, double scale, double min, double max, long usemin, long usemax)
	Attaches a clip/scale filter to an attribute. More...

t_max_err	attr_addfilterset_proc (void *x, method proc)
	Attaches a custom filter method to an attribute. More...

t_max_err	attr_addfilterget_proc (void *x, method proc)
	Attaches a custom filter method to an attribute. More...

void	attr_args_dictionary (t_dictionary x, short ac, t_atom av)
	Create a dictionary of attribute-name, attribute-value pairs from an array of atoms containing an attribute definition list. More...

void	attr_dictionary_process (void x, t_dictionary d)
	Set attributes for an object that are defined in a dictionary. More...

void	attr_dictionary_check (void x, t_dictionary d)
	Check that a dictionary only contains values for existing attributes of an object. More...

t_max_err	object_attr_setparse (t_object x, t_symbol s, C74_CONST char *parsestr)
	Set an attribute value with one or more atoms parsed from a C-string. More...

void *	object_new_parse (t_symbol name_space, t_symbol classname, C74_CONST char *parsestr)
	Create a new object with one or more atoms parsed from a C-string. More...

t_max_err	object_attr_getjrgba (void ob, t_symbol s, t_jrgba *c)
	Retrieves the value of a color attribute, given its parent object and name. More...

t_max_err	object_attr_setjrgba (void ob, t_symbol s, t_jrgba *c)
	Sets the value of a color attribute, given its parent object and name. More...

t_max_err	object_attr_get_rect (t_object o, t_symbol name, t_rect *rect)
	Gets the value of a t_rect attribute, given its parent object and name. More...

t_max_err	object_attr_set_rect (t_object o, t_symbol name, t_rect *rect)
	Sets the value of a t_rect attribute, given its parent object and name. More...

void	object_attr_set_xywh (t_object o, t_symbol attr, double x, double y, double w, double h)
	Sets the value of a t_rect attribute, given its parent object and name. More...

t_max_err	object_attr_getpt (t_object o, t_symbol name, t_pt *pt)
	Gets the value of a t_pt attribute, given its parent object and name. More...

t_max_err	object_attr_setpt (t_object o, t_symbol name, t_pt *pt)
	Sets the value of a t_pt attribute, given its parent object and name. More...

t_max_err	object_attr_getsize (t_object o, t_symbol name, t_size *size)
	Gets the value of a t_size attribute, given its parent object and name. More...

t_max_err	object_attr_setsize (t_object o, t_symbol name, t_size *size)
	Sets the value of a t_size attribute, given its parent object and name. More...

t_max_err	object_attr_getcolor (t_object b, t_symbol attrname, t_jrgba *prgba)
	Gets the value of a t_jrgba attribute, given its parent object and name. More...

t_max_err	object_attr_setcolor (t_object b, t_symbol attrname, t_jrgba *prgba)
	Sets the value of a t_jrgba attribute, given its parent object and name. More...

Detailed Description

An attribute of an object is a setting or property that tells the object how to do its job.

For example, the metro object has an interval attribute that tells it how fast to run.

Attributes are similar to methods, except that the attributes have a state. Attributes are themselves objects, and they share a common interface for getting and setting values.

An attribute is most typically added to the class definition of another object during it's class initialization or ext_main() function. Most typically, this attribute's value will be stored in an instance's struct, and thus it will serve as a property of that instance of the object.

Attributes can, however, be declared as 'class static'. This means that the property is shared by all instances of the class, and the value is stored as a shared (static) variable.

Additionally, Max 5 has introduced the notion of 'instance attributes' (also called 'object attributes'). Instance attributes are the creation of an attribute object, and then adding it to one specific instance of another class.

Finally, because attributes themselves are Max objects they too can possess attributes. These 'attributes of attributes' are used in Max to do things like specify a range of values for an attribute, give an attribute human friendly caption, or determine to what category an attribute should belong in the inspector.

The easiest and most common way of working with attributes is to use the provided macros. These macros simplify the process of creating a new attribute object, setting any attributes of the attribute, and binding it to an object class or an object instance.

Setting and Getting Attribute Values

By default, Max provides standard attribute accessors. These are the functions the get or set the attribute value in the object's struct. If you need to define a custom accessor, you can specify this information using the CLASS_ATTR_ACCESSORS macro.

Writing a custom Attribute Getter

If you need to define a custom accessor, it should have a prototype and form comparable to the following custom getter:

t_max_err foo_myval_get(t_foo *x, void *attr, long *ac, t_atom **av)
{
   if ((*ac)&&(*av)) {
      //memory passed in, use it
   } else {
      //otherwise allocate memory
       *ac = 1;
      if (!(*av = getbytes(sizeof(t_atom)*(*ac)))) {
          *ac = 0;
         return MAX_ERR_OUT_OF_MEM;
      }
   }
   atom_setfloat(*av,x->myval);
   return MAX_ERR_NONE;
}

Note that getters require memory to be allocated, if there is not memory passed into the getter. Also the attr argument is the class' attribute object and can be queried using object_method for things like the attribute flags, names, filters, etc..

Writing a custom Attribute Setter

If you need to define a custom accessor, it should have a prototype and form comparable to the following custom setter:

t_max_err foo_myval_set(t_foo *x, void *attr, long ac, t_atom *av)
{
   if (ac&&av) {
      x->myval = atom_getfloat(av);
   } else {
      // no args, set to zero
      x->myval = 0;
   }
   return MAX_ERR_NONE;
}

Attribute Notificaton

Although the subject of object registration and notification is covered elsewhere, it bears noting that attributes of all types will, if registered, automatically send notifications to all attached client objects each time the attribute's value is set.

Macro Definition Documentation

#define CLASS_ATTR_ACCESSORS	(	c,
		attrname,
		getter,
		setter
	)

Specify custom accessor methods for an attribute.

If you specify a non-NULL value for the setter or getter, then the function you specify will be called to set or get the attribute's value rather than using the built-in accessor.

Parameters

c	The class pointer.
attrname	The name of the attribute as a C-string.
getter	An appropriate getter method as discussed in Setting and Getting Attribute Values, or NULL to use the default getter.
setter	An appropriate setter method as discussed in Setting and Getting Attribute Values, or NULL to use the default setter.

#define CLASS_ATTR_ADD_FLAGS	(	c,
		attrname,
		flags
	)

Add flags to an attribute.

Parameters

c	The class pointer.
attrname	The name of the attribute as a C-string.
flags	Any flags you wish to add to this attribute, as defined in e_max_attrflags.

#define CLASS_ATTR_ALIAS	(	c,
		attrname,
		aliasname
	)

Create a new attribute that is an alias of an existing attribute.

Parameters

c	The class pointer.
attrname	The name of the actual attribute as a C-string.
aliasname	The name of the new alias attribute.

#define CLASS_ATTR_ATOM	(	c,
		attrname,
		flags,
		structname,
		structmember
	)

Create a t_atom attribute and add it to a Max class.

Parameters

c	The class pointer.
attrname	The name of this attribute as a C-string.
flags	Any flags you wish to declare for this attribute, as defined in e_max_attrflags.
structname	The C identifier for the struct (containing a valid t_object header) representing an instance of this class.
structmember	The C identifier of the member in the struct that holds the value of this attribute.

#define CLASS_ATTR_ATOM_ARRAY	(	c,
		attrname,
		flags,
		structname,
		structmember,
		size
	)

Create an array-of-atoms attribute of fixed length, and add it to a Max class.

Parameters

c	The class pointer.
attrname	The name of this attribute as a C-string.
flags	Any flags you wish to declare for this attribute, as defined in e_max_attrflags.
structname	The C identifier for the struct (containing a valid t_object header) representing an instance of this class.
structmember	The C identifier of the member in the struct that holds the value of this attribute.
size	The number of items in the t_atom array.

#define CLASS_ATTR_ATOM_LONG	(	c,
		attrname,
		flags,
		structname,
		structmember
	)

Create a t_atom_long integer attribute and add it to a Max class.

Parameters

c	The class pointer.
attrname	The name of this attribute as a C-string.
flags	Any flags you wish to declare for this attribute, as defined in e_max_attrflags.
structname	The C identifier for the struct (containing a valid t_object header) representing an instance of this class.
structmember	The C identifier of the member in the struct that holds the value of this attribute.

#define CLASS_ATTR_ATOM_LONG_ARRAY	(	c,
		attrname,
		flags,
		structname,
		structmember,
		size
	)

Create an array-of-t_atom_long-integers attribute of fixed length, and add it to a Max class.

Parameters

c	The class pointer.
attrname	The name of this attribute as a C-string.
flags	Any flags you wish to declare for this attribute, as defined in e_max_attrflags.
structname	The C identifier for the struct (containing a valid t_object header) representing an instance of this class.
structmember	The C identifier of the member in the struct that holds the value of this attribute.
size	The number of longs in the array.

#define CLASS_ATTR_ATOM_VARSIZE	(	c,
		attrname,
		flags,
		structname,
		structmember,
		sizemember,
		maxsize
	)

Create an array-of-atoms attribute of variable length, and add it to a Max class.

Parameters

c	The class pointer.
attrname	The name of this attribute as a C-string.
flags	Any flags you wish to declare for this attribute, as defined in e_max_attrflags.
structname	The C identifier for the struct (containing a valid t_object header) representing an instance of this class.
structmember	The C identifier of the member in the struct that holds the value of this attribute.
sizemember	The actual number of items in the t_atom array at any given moment.
maxsize	The maximum number of items in the t_atom array, i.e. the number of members allocated for the array in the struct.

#define CLASS_ATTR_BASIC	(	c,
		attrname,
		flags
	)

Add a new attribute to the specified attribute to specify that it should appear in the inspector's Basic tab.

Parameters

c	The class pointer.
attrname	The name of the attribute as a C-string.
flags	Any flags you wish to declare for this new attribute, as defined in e_max_attrflags.

Referenced by jit_ob3d_setup().

#define CLASS_ATTR_CATEGORY	(	c,
		attrname,
		flags,
		parsestr
	)

Add a new attribute to the specified attribute to specify a category to which the attribute is assigned in the Max inspector.

Categories are represented in the inspector as tabs. If the specified category does not exist then it will be created.

Parameters

c	The class pointer.
attrname	The name of the attribute as a C-string.
flags	Any flags you wish to declare for this new attribute, as defined in e_max_attrflags.
parsestr	A C-string, which will be parsed into an array of atoms to set the initial value.

#define CLASS_ATTR_CHAR	(	c,
		attrname,
		flags,
		structname,
		structmember
	)

Create a char attribute and add it to a Max class.

Parameters

c	The class pointer.
attrname	The name of this attribute as a C-string.
flags	Any flags you wish to declare for this attribute, as defined in e_max_attrflags.
structname	The C identifier for the struct (containing a valid t_object header) representing an instance of this class.
structmember	The C identifier of the member in the struct that holds the value of this attribute.

#define CLASS_ATTR_CHAR_ARRAY	(	c,
		attrname,
		flags,
		structname,
		structmember,
		size
	)

Create an array-of-chars attribute of fixed length, and add it to a Max class.

Parameters

c	The class pointer.
attrname	The name of this attribute as a C-string.
flags	Any flags you wish to declare for this attribute, as defined in e_max_attrflags.
structname	The C identifier for the struct (containing a valid t_object header) representing an instance of this class.
structmember	The C identifier of the member in the struct that holds the value of this attribute.
size	The number of chars in the array.

#define CLASS_ATTR_CHAR_VARSIZE	(	c,
		attrname,
		flags,
		structname,
		structmember,
		sizemember,
		maxsize
	)

Create an array-of-chars attribute of variable length, and add it to a Max class.

Parameters

c	The class pointer.
attrname	The name of this attribute as a C-string.
flags	Any flags you wish to declare for this attribute, as defined in e_max_attrflags.
structname	The C identifier for the struct (containing a valid t_object header) representing an instance of this class.
structmember	The C identifier of the member in the struct that holds the value of this attribute.
sizemember	The actual number of items in the char array at any given moment.
maxsize	The maximum number of items in the char array, i.e. the number of members allocated for the array in the struct.

#define CLASS_ATTR_DEFAULT	(	c,
		attrname,
		flags,
		parsestr
	)

Add a new attribute to the specified attribute to specify a default value.

The default value will be automatically set when the object is created only if your object uses a dictionary constructor with the CLASS_FLAG_NEWDICTIONARY flag.

Parameters

c	The class pointer.
attrname	The name of the attribute as a C-string.
flags	Any flags you wish to declare for this new attribute, as defined in e_max_attrflags.
parsestr	A C-string, which will be parsed into an array of atoms to set the initial value.

#define CLASS_ATTR_DEFAULT_PAINT	(	c,
		attrname,
		flags,
		parsestr
	)

A convenience wrapper for both CLASS_ATTR_DEFAULT and CLASS_ATTR_PAINT.

Parameters

c	The class pointer.
attrname	The name of the attribute as a C-string.
flags	Any flags you wish to declare for this new attribute, as defined in e_max_attrflags.
parsestr	A C-string, which will be parsed into an array of atoms to set the initial value.

See also: CLASS_ATTR_DEFAULT; CLASS_ATTR_PAINT

#define CLASS_ATTR_DEFAULT_SAVE	(	c,
		attrname,
		flags,
		parsestr
	)

A convenience wrapper for both CLASS_ATTR_DEFAULT and CLASS_ATTR_SAVE.

Parameters

c	The class pointer.
attrname	The name of the attribute as a C-string.
flags	Any flags you wish to declare for this new attribute, as defined in e_max_attrflags.
parsestr	A C-string, which will be parsed into an array of atoms to set the initial value.

See also: CLASS_ATTR_DEFAULT; CLASS_ATTR_SAVE

#define CLASS_ATTR_DEFAULT_SAVE_PAINT	(	c,
		attrname,
		flags,
		parsestr
	)

A convenience wrapper for CLASS_ATTR_DEFAULT, CLASS_ATTR_SAVE, and CLASS_ATTR_PAINT.

Parameters

c	The class pointer.
attrname	The name of the attribute as a C-string.
flags	Any flags you wish to declare for this new attribute, as defined in e_max_attrflags.
parsestr	A C-string, which will be parsed into an array of atoms to set the initial value.

See also: CLASS_ATTR_DEFAULT; CLASS_ATTR_PAINT; CLASS_ATTR_SAVE

#define CLASS_ATTR_DEFAULTNAME	(	c,
		attrname,
		flags,
		parsestr
	)

Add a new attribute to the specified attribute to specify a default value, based on Max's Object Defaults.

If a value is present in Max's Object Defaults, then that value will be used as the default value. Otherwise, use the default value specified here. The default value will be automatically set when the object is created only if your object uses a dictionary constructor with the CLASS_FLAG_NEWDICTIONARY flag.

Parameters

c	The class pointer.
attrname	The name of the attribute as a C-string.
flags	Any flags you wish to declare for this new attribute, as defined in e_max_attrflags.
parsestr	A C-string, which will be parsed into an array of atoms to set the initial value.

#define CLASS_ATTR_DEFAULTNAME_PAINT	(	c,
		attrname,
		flags,
		parsestr
	)

A convenience wrapper for CLASS_ATTR_DEFAULTNAME, CLASS_ATTR_SAVE, and CLASS_ATTR_PAINT.

Parameters

c	The class pointer.
attrname	The name of the attribute as a C-string.
flags	Any flags you wish to declare for this new attribute, as defined in e_max_attrflags.
parsestr	A C-string, which will be parsed into an array of atoms to set the initial value.

See also: CLASS_ATTR_DEFAULTNAME; CLASS_ATTR_PAINT; CLASS_ATTR_SAVE

#define CLASS_ATTR_DEFAULTNAME_SAVE	(	c,
		attrname,
		flags,
		parsestr
	)

A convenience wrapper for both CLASS_ATTR_DEFAULTNAME and CLASS_ATTR_SAVE.

Parameters

c	The class pointer.
attrname	The name of the attribute as a C-string.
flags	Any flags you wish to declare for this new attribute, as defined in e_max_attrflags.
parsestr	A C-string, which will be parsed into an array of atoms to set the initial value.

See also: CLASS_ATTR_DEFAULTNAME; CLASS_ATTR_SAVE

#define CLASS_ATTR_DEFAULTNAME_SAVE_PAINT	(	c,
		attrname,
		flags,
		parsestr
	)

A convenience wrapper for CLASS_ATTR_DEFAULTNAME, CLASS_ATTR_SAVE, and CLASS_ATTR_PAINT.

Parameters

c	The class pointer.
attrname	The name of the attribute as a C-string.
flags	Any flags you wish to declare for this new attribute, as defined in e_max_attrflags.
parsestr	A C-string, which will be parsed into an array of atoms to set the initial value.

See also: CLASS_ATTR_DEFAULTNAME; CLASS_ATTR_PAINT; CLASS_ATTR_SAVE

#define CLASS_ATTR_DOUBLE	(	c,
		attrname,
		flags,
		structname,
		structmember
	)

Create a 64-bit float attribute and add it to a Max class.

Parameters

c	The class pointer.
attrname	The name of this attribute as a C-string.
flags	Any flags you wish to declare for this attribute, as defined in e_max_attrflags.
structname	The C identifier for the struct (containing a valid t_object header) representing an instance of this class.
structmember	The C identifier of the member in the struct that holds the value of this attribute.

#define CLASS_ATTR_DOUBLE_ARRAY	(	c,
		attrname,
		flags,
		structname,
		structmember,
		size
	)

Create an array-of-64bit-floats attribute of fixed length, and add it to a Max class.

Parameters

c	The class pointer.
attrname	The name of this attribute as a C-string.
flags	Any flags you wish to declare for this attribute, as defined in e_max_attrflags.
structname	The C identifier for the struct (containing a valid t_object header) representing an instance of this class.
structmember	The C identifier of the member in the struct that holds the value of this attribute.
size	The number of doubles in the array.

#define CLASS_ATTR_DOUBLE_VARSIZE	(	c,
		attrname,
		flags,
		structname,
		structmember,
		sizemember,
		maxsize
	)

Create an array-of-64bit-floats attribute of variable length, and add it to a Max class.

Parameters

c	The class pointer.
attrname	The name of this attribute as a C-string.
flags	Any flags you wish to declare for this attribute, as defined in e_max_attrflags.
structname	The C identifier for the struct (containing a valid t_object header) representing an instance of this class.
structmember	The C identifier of the member in the struct that holds the value of this attribute.
sizemember	The actual number of items in the double array at any given moment.
maxsize	The maximum number of items in the double array, i.e. the number of members allocated for the array in the struct.

#define CLASS_ATTR_ENUM	(	c,
		attrname,
		flags,
		parsestr
	)

Add a new attribute to the specified attribute to specify a list of choices to display in a menu for the Max inspector.

Parameters

c	The class pointer.
attrname	The name of the attribute as a C-string.
flags	Any flags you wish to declare for this new attribute, as defined in e_max_attrflags.
parsestr	A C-string, which will be parsed into an array of atoms to set the initial value.

Remarks: This macro automatically calls
1 CLASS_ATTR_STYLE(c,attrname,flags,"enum").

See also: CLASS_ATTR_ENUMINDEX

Referenced by jit_ob3d_setup().

#define CLASS_ATTR_ENUMINDEX	(	c,
		attrname,
		flags,
		parsestr
	)

Add a new attribute to the specified attribute to specify a list of choices to display in a menu for the Max inspector.

Parameters

c	The class pointer.
attrname	The name of the attribute as a C-string.
flags	Any flags you wish to declare for this new attribute, as defined in e_max_attrflags.
parsestr	A C-string, which will be parsed into an array of atoms to set the initial value.

Remarks: This macro automatically calls
1 CLASS_ATTR_STYLE(c,attrname,flags,"enumindex").

See also: CLASS_ATTR_ENUM

#define CLASS_ATTR_FILTER_CLIP	(	c,
		attrname,
		minval,
		maxval
	)

Add a filter to the attribute to limit both the lower and upper bounds of a value.

The limiting will be performed by the default attribute accessor.

Parameters

c	The class pointer.
attrname	The name of the attribute as a C-string.
minval	The maximum acceptable value to which the attribute will be limited.
maxval	The maximum acceptable value to which the attribute will be limited.

See also

#define CLASS_ATTR_FILTER_MAX	(	c,
		attrname,
		maxval
	)

Add a filter to the attribute to limit the upper bound of a value.

The limiting will be performed by the default attribute accessor.

Parameters

c	The class pointer.
attrname	The name of the attribute as a C-string.
maxval	The maximum acceptable value to which the attribute will be limited.

See also: CLASS_ATTR_FILTER_MIN; CLASS_ATTR_FILTER_CLIP; CLASS_ATTR_MAX

#define CLASS_ATTR_FILTER_MIN	(	c,
		attrname,
		minval
	)

Add a filter to the attribute to limit the lower bound of a value.

The limiting will be performed by the default attribute accessor.

Parameters

c	The class pointer.
attrname	The name of the attribute as a C-string.
minval	The minimum acceptable value to which the attribute will be limited.

See also: CLASS_ATTR_FILTER_MAX; CLASS_ATTR_FILTER_CLIP; CLASS_ATTR_MIN

#define CLASS_ATTR_FLOAT	(	c,
		attrname,
		flags,
		structname,
		structmember
	)

Create a 32-bit float attribute and add it to a Max class.

Parameters

c	The class pointer.
attrname	The name of this attribute as a C-string.
flags	Any flags you wish to declare for this attribute, as defined in e_max_attrflags.
structname	The C identifier for the struct (containing a valid t_object header) representing an instance of this class.
structmember	The C identifier of the member in the struct that holds the value of this attribute.

#define CLASS_ATTR_FLOAT_ARRAY	(	c,
		attrname,
		flags,
		structname,
		structmember,
		size
	)

Create an array-of-32bit-floats attribute of fixed length, and add it to a Max class.

Parameters

c	The class pointer.
attrname	The name of this attribute as a C-string.
flags	Any flags you wish to declare for this attribute, as defined in e_max_attrflags.
structname	The C identifier for the struct (containing a valid t_object header) representing an instance of this class.
structmember	The C identifier of the member in the struct that holds the value of this attribute.
size	The number of floats in the array.

#define CLASS_ATTR_FLOAT_VARSIZE	(	c,
		attrname,
		flags,
		structname,
		structmember,
		sizemember,
		maxsize
	)

Create an array-of-32bit-floats attribute of variable length, and add it to a Max class.

Parameters

c	The class pointer.
attrname	The name of this attribute as a C-string.
flags	Any flags you wish to declare for this attribute, as defined in e_max_attrflags.
structname	The C identifier for the struct (containing a valid t_object header) representing an instance of this class.
structmember	The C identifier of the member in the struct that holds the value of this attribute.
sizemember	The actual number of items in the float array at any given moment.
maxsize	The maximum number of items in the float array, i.e. the number of members allocated for the array in the struct.

#define CLASS_ATTR_INT32	(	c,
		attrname,
		flags,
		structname,
		structmember
	)

Create a t_int32 integer attribute and add it to a Max class.

Parameters

c	The class pointer.
attrname	The name of this attribute as a C-string.
flags	Any flags you wish to declare for this attribute, as defined in e_max_attrflags.
structname	The C identifier for the struct (containing a valid t_object header) representing an instance of this class.
structmember	The C identifier of the member in the struct that holds the value of this attribute.

#define CLASS_ATTR_INTRODUCED	(	c,
		attrname,
		flags,
		versionstr
	)

Add a new attribute to the specified attribute to indicate in which version the attribute was introduced.

Parameters

c	The class pointer.
attrname	The name of the attribute as a C-string.
flags	Any flags you wish to declare for this new attribute, as defined in e_max_attrflags.
versionstr	A C-string, which will be parsed set the version number (e.g. "7.0.0").

#define CLASS_ATTR_INVISIBLE	(	c,
		attrname,
		flags
	)

Add a new attribute to the specified attribute to flag an attribute as invisible to the Max inspector.

Parameters

c	The class pointer.
attrname	The name of the attribute as a C-string.
flags	Any flags you wish to declare for this new attribute, as defined in e_max_attrflags.

#define CLASS_ATTR_LABEL	(	c,
		attrname,
		flags,
		labelstr
	)

Add a new attribute to the specified attribute to specify an a human-friendly label for the Max inspector.

Parameters

c	The class pointer.
attrname	The name of the attribute as a C-string.
flags	Any flags you wish to declare for this new attribute, as defined in e_max_attrflags.
labelstr	A C-string, which will be parsed into an array of atoms to set the initial value.

#define CLASS_ATTR_LEGACYDEFAULT	(	c,
		legacyattrname,
		newattrname,
		flags,
		parsestr
	)

Add a new attribute to the specified attribute to specify a legacy default value.

The default value will be automatically set when the object is created only if your object uses a dictionary constructor with the CLASS_FLAG_NEWDICTIONARY flag.

Parameters

c	The class pointer.
legacyattrname	The name of the attribute.
newattrname	The name of the attribute.
flags	Any flags you wish to declare for this new attribute, as defined in e_max_attrflags.
parsestr	A C-string, which will be parsed into an array of atoms to set the legacy value, used by jbox_processlegacydefaults()

#define CLASS_ATTR_LONG	(	c,
		attrname,
		flags,
		structname,
		structmember
	)

Create a t_atom_long integer attribute and add it to a Max class.

Parameters

c	The class pointer.
attrname	The name of this attribute as a C-string.
flags	Any flags you wish to declare for this attribute, as defined in e_max_attrflags.
structname	The C identifier for the struct (containing a valid t_object header) representing an instance of this class.
structmember	The C identifier of the member in the struct that holds the value of this attribute.

#define CLASS_ATTR_LONG_ARRAY	(	c,
		attrname,
		flags,
		structname,
		structmember,
		size
	)

Create an array-of-long-integers attribute of fixed length, and add it to a Max class.

Parameters

c	The class pointer.
attrname	The name of this attribute as a C-string.
flags	Any flags you wish to declare for this attribute, as defined in e_max_attrflags.
structname	The C identifier for the struct (containing a valid t_object header) representing an instance of this class.
structmember	The C identifier of the member in the struct that holds the value of this attribute.
size	The number of longs in the array.

#define CLASS_ATTR_LONG_VARSIZE	(	c,
		attrname,
		flags,
		structname,
		structmember,
		sizemember,
		maxsize
	)

Create an array-of-long-integers attribute of variable length, and add it to a Max class.

Parameters

c	The class pointer.
attrname	The name of this attribute as a C-string.
flags	Any flags you wish to declare for this attribute, as defined in e_max_attrflags.
structname	The C identifier for the struct (containing a valid t_object header) representing an instance of this class.
structmember	The C identifier of the member in the struct that holds the value of this attribute.
sizemember	The actual number of items in the long array at any given moment.
maxsize	The maximum number of items in the long array, i.e. the number of members allocated for the array in the struct.

#define CLASS_ATTR_MAX	(	c,
		attrname,
		flags,
		parsestr
	)

Add a new attribute to the specified attribute to specify an upper range.

The values will not be automatically limited.

Parameters

c	The class pointer.
attrname	The name of the attribute as a C-string.
flags	Any flags you wish to declare for this new attribute, as defined in e_max_attrflags.
parsestr	A C-string, which will be parsed into an array of atoms to set the initial value.

See also: CLASS_ATTR_MIN; CLASS_ATTR_FILTER_MAX; CLASS_ATTR_FILTER_CLIP

#define CLASS_ATTR_MIN	(	c,
		attrname,
		flags,
		parsestr
	)

Add a new attribute to the specified attribute to specify a lower range.

The values will not be automatically limited.

Parameters

c	The class pointer.
attrname	The name of the attribute as a C-string.
flags	Any flags you wish to declare for this new attribute, as defined in e_max_attrflags.
parsestr	A C-string, which will be parsed into an array of atoms to set the initial value.

See also: CLASS_ATTR_MAX; CLASS_ATTR_FILTER_MAX; CLASS_ATTR_FILTER_CLIP

#define CLASS_ATTR_OBJ	(	c,
		attrname,
		flags,
		structname,
		structmember
	)

Create a t_object* attribute and add it to a Max class.

Parameters

c	The class pointer.
attrname	The name of this attribute as a C-string.
flags	Any flags you wish to declare for this attribute, as defined in e_max_attrflags.
structname	The C identifier for the struct (containing a valid t_object header) representing an instance of this class.
structmember	The C identifier of the member in the struct that holds the value of this attribute.

#define CLASS_ATTR_OBJ_ARRAY	(	c,
		attrname,
		flags,
		structname,
		structmember,
		size
	)

Create an array-of-objects attribute of fixed length, and add it to a Max class.

Parameters

c	The class pointer.
attrname	The name of this attribute as a C-string.
flags	Any flags you wish to declare for this attribute, as defined in e_max_attrflags.
structname	The C identifier for the struct (containing a valid t_object header) representing an instance of this class.
structmember	The C identifier of the member in the struct that holds the value of this attribute.
size	The number of items in the t_object* array.

#define CLASS_ATTR_OBJ_VARSIZE	(	c,
		attrname,
		flags,
		structname,
		structmember,
		sizemember,
		maxsize
	)

Create an array-of-objects attribute of variable length, and add it to a Max class.

Parameters

c	The class pointer.
attrname	The name of this attribute as a C-string.
flags	Any flags you wish to declare for this attribute, as defined in e_max_attrflags.
structname	The C identifier for the struct (containing a valid t_object header) representing an instance of this class.
structmember	The C identifier of the member in the struct that holds the value of this attribute.
sizemember	The actual number of items in the t_object* array at any given moment.
maxsize	The maximum number of items in the t_object* array, i.e. the number of members allocated for the array in the struct.

#define CLASS_ATTR_OBSOLETE	(	c,
		attrname,
		flags
	)

Add a new attribute to the specified attribute to flag it as obsolete.

Parameters

c	The class pointer.
attrname	The name of the attribute as a C-string.
flags	Any flags you wish to declare for this new attribute, as defined in e_max_attrflags.

#define CLASS_ATTR_ORDER	(	c,
		attrname,
		flags,
		parsestr
	)

Add a new attribute to the specified attribute to specify a default order in which to list attributes.

Parameters

c	The class pointer.
attrname	The name of the attribute as a C-string.
flags	Any flags you wish to declare for this new attribute, as defined in e_max_attrflags.
parsestr	A C-string, which will be parsed into an array of atoms to set the initial value.

Remarks: A value of zero indicates that there is no ordering. Ordering values begin at 1. For example:
1 CLASS_ATTR_ORDER(c, "firstattr", 0, "1");

2 CLASS_ATTR_ORDER(c, "secondattr", 0, "2");

3 CLASS_ATTR_ORDER(c, "thirdattr", 0, "3");

#define CLASS_ATTR_PAINT	(	c,
		attrname,
		flags
	)

Add a new attribute indicating that any changes to the specified attribute will trigger a call to the object's paint method.

Parameters

c	The class pointer.
attrname	The name of the attribute as a C-string.
flags	Any flags you wish to declare for this new attribute, as defined in e_max_attrflags.

#define CLASS_ATTR_REMOVE_FLAGS	(	c,
		attrname,
		flags
	)

Remove flags from an attribute.

Parameters

c	The class pointer.
attrname	The name of the attribute as a C-string.
flags	Any flags you wish to remove from this attribute, as defined in e_max_attrflags.

#define CLASS_ATTR_RENAMED	(	c,
		oldname,
		newname,
		flags
	)

Add a new attribute to the specified attribute to flag it as renamed.

Parameters

c	The class pointer.
oldname	The name of the old attribute as a C-string.
newname	The name of the new attribute as a C-string.
flags	Any flags you wish to declare for this new attribute, as defined in e_max_attrflags.

#define CLASS_ATTR_RGBA	(	c,
		attrname,
		flags,
		structname,
		structmember
	)

Create a color (t_jrgba) attribute and add it to a Max class.

Parameters

c	The class pointer.
attrname	The name of this attribute as a C-string.
flags	Any flags you wish to declare for this attribute, as defined in e_max_attrflags.
structname	The C identifier for the struct (containing a valid t_object header) representing an instance of this class.
structmember	The C identifier of the member in the struct that holds the value of this attribute.

#define CLASS_ATTR_SAVE	(	c,
		attrname,
		flags
	)

Add a new attribute to the specified attribute to indicate that the specified attribute should be saved with the patcher.

Parameters

c	The class pointer.
attrname	The name of the attribute as a C-string.
flags	Any flags you wish to declare for this new attribute, as defined in e_max_attrflags.

#define CLASS_ATTR_SELFSAVE	(	c,
		attrname,
		flags
	)

Add a new attribute to the specified attribute to indicate that it is saved by the object (so it does not appear in italics in the inspector).

Parameters

c	The class pointer.
attrname	The name of the attribute as a C-string.
flags	Any flags you wish to declare for this new attribute, as defined in e_max_attrflags.

#define CLASS_ATTR_STYLE	(	c,
		attrname,
		flags,
		parsestr
	)

Add a new attribute to the specified attribute to specify an editor style for the Max inspector.

Available styles include

"text" : a text editor
"onoff" : a toggle switch
"rgba" : a color chooser
"enum" : a menu of available choices, whose symbol will be passed upon selection
"enumindex" : a menu of available choices, whose index will be passed upon selection
"rect" : a style for displaying and editing t_rect values
"font" : a font chooser
"file" : a file chooser dialog

Parameters

c	The class pointer.
attrname	The name of the attribute as a C-string.
flags	Any flags you wish to declare for this new attribute, as defined in e_max_attrflags.
parsestr	A C-string, which will be parsed into an array of atoms to set the initial value.

#define CLASS_ATTR_STYLE_LABEL	(	c,
		attrname,
		flags,
		stylestr,
		labelstr
	)

A convenience wrapper for CLASS_ATTR_STYLE, and CLASS_ATTR_LABEL.

Parameters

c	The class pointer.
attrname	The name of the attribute as a C-string.
flags	Any flags you wish to declare for this new attribute, as defined in e_max_attrflags.
stylestr	A C-string that names the style for the attribute. See CLASS_ATTR_STYLE for the available styles.
labelstr	A C-string that names the category to which the attribute is assigned in the inspector.

See also: CLASS_ATTR_STYLE; CLASS_ATTR_LABEL

#define CLASS_ATTR_SYM	(	c,
		attrname,
		flags,
		structname,
		structmember
	)

Create a t_symbol* attribute and add it to a Max class.

Parameters

c	The class pointer.
attrname	The name of this attribute as a C-string.
flags	Any flags you wish to declare for this attribute, as defined in e_max_attrflags.
structname	The C identifier for the struct (containing a valid t_object header) representing an instance of this class.
structmember	The C identifier of the member in the struct that holds the value of this attribute.

#define CLASS_ATTR_SYM_ARRAY	(	c,
		attrname,
		flags,
		structname,
		structmember,
		size
	)

Create an array-of-symbols attribute of fixed length, and add it to a Max class.

Parameters

c	The class pointer.
attrname	The name of this attribute as a C-string.
flags	Any flags you wish to declare for this attribute, as defined in e_max_attrflags.
structname	The C identifier for the struct (containing a valid t_object header) representing an instance of this class.
structmember	The C identifier of the member in the struct that holds the value of this attribute.
size	The number of items in the t_symbol* array.

#define CLASS_ATTR_SYM_VARSIZE	(	c,
		attrname,
		flags,
		structname,
		structmember,
		sizemember,
		maxsize
	)

Create an array-of-symbols attribute of variable length, and add it to a Max class.

Parameters

c	The class pointer.
attrname	The name of this attribute as a C-string.
flags	Any flags you wish to declare for this attribute, as defined in e_max_attrflags.
structname	The C identifier for the struct (containing a valid t_object header) representing an instance of this class.
structmember	The C identifier of the member in the struct that holds the value of this attribute.
sizemember	The actual number of items in the t_symbol* array at any given moment.
maxsize	The maximum number of items in the t_symbol* array, i.e. the number of members allocated for the array in the struct.

#define CLASS_METHOD_ATTR_PARSE	(	c,
		methodname,
		attrname,
		type,
		flags,
		parsestring
	)

Define and add attributes to class methods.

Parameters

c	The class pointer.
methodname	The name of the existing method as a C-string.
attrname	The name of the attribute to add as a C-string.
type	The datatype of the attribute to be added.
flags	Any flags you wish to declare for this new attribute, as defined in e_max_attrflags.
parsestring	A C-string, which will be parsed into an array of atoms to set the initial value.

Remarks: An example which makes a method invisible to users:
1 class_addmethod(c, (method)my_foo, "foo", 0);

2 CLASS_METHOD_ATTR_PARSE(c, "foo", "undocumented", gensym("long"), 0, "1");

Referenced by jit_ob3d_setup().

#define CLASS_METHOD_INTRODUCED	(	c,
		methodname,
		flags,
		versionstr
	)

Add a new attribute to the specified method to indicate in which version the method was introduced.

Parameters

c	The class pointer.
methodname	The name of the method as a C-string.
flags	Any flags you wish to declare for this new attribute, as defined in e_max_attrflags.
versionstr	A C-string, which will be parsed set the version number (e.g. "7.0.0").

#define CLASS_METHOD_OBSOLETE	(	c,
		methodname,
		flags
	)

Add a new attribute to the specified method to flag it as obsolete.

Parameters

c	The class pointer.
methodname	The name of the method as a C-string.
flags	Any flags you wish to declare for this new attribute, as defined in e_max_attrflags.

#define CLASS_METHOD_RENAMED	(	c,
		oldname,
		newname,
		flags
	)

Add a new attribute to the specified method to flag a method as renamed.

Parameters

c	The class pointer.
oldname	The name of the old method as a C-string.
newname	The name of the new method as a C-string.
flags	Any flags you wish to declare for this new attribute, as defined in e_max_attrflags.

#define CLASS_STICKY_ATTR	(	c,
		name,
		flags,
		parsestr
	)

Create an attribute, and add it to all following attribute declarations.

The block is closed by a call to CLASS_STICKY_ATTR_CLEAR.

Parameters

c	The class pointer.
name	The name of the new attribute to create as a C-string.
flags	Any flags you wish to declare for this new attribute, as defined in e_max_attrflags.
parsestr	A C-string, which will be parsed into an array of atoms to set the initial value.

Remarks: The most common use of CLASS_STICKY_ATTR is for creating multiple attributes with the same category, as in this example:
1 CLASS_STICKY_ATTR(c, "category", 0, "Foo");

2

3 CLASS_ATTR_DOUBLE(c, "bar", 0, t_myobject, x_bar);

4 CLASS_ATTR_LABEL(c, "bar", 0, "A Bar");

5

6 CLASS_ATTR_CHAR(c, "switch", 0, t_myobject, x_switch);

7 CLASS_ATTR_STYLE_LABEL(c, "switch", 0, "onoff", "Bar Switch");

8

9 CLASS_ATTR_DOUBLE(c, "flow", 0, t_myobject, x_flow);

10 CLASS_ATTR_LABEL(c, "flow", 0, "Flow Amount");

11

12 CLASS_STICKY_ATTR_CLEAR(c, "category");

See also: CLASS_STICKY_ATTR_CLEAR

#define CLASS_STICKY_ATTR_CLEAR	(	c,
		name
	)

Close a CLASS_STICKY_ATTR block.

Parameters

c	The class pointer.
name	The name of the sticky attribute as a C-string.

See also: CLASS_STICKY_ATTR

#define CLASS_STICKY_METHOD	(	c,
		name,
		flags,
		parsestr
	)

Create an attribute, and add it to all following method declarations.

The block is closed by a call to CLASS_STICKY_METHOD_CLEAR.

Parameters

c	The class pointer.
name	The name of the new attribute to create as a C-string.
flags	Any flags you wish to declare for this new attribute, as defined in e_max_attrflags.
parsestr	A C-string, which will be parsed into an array of atoms to set the initial value.

Remarks: The most common use of CLASS_STICKY_ATTR is for creating multiple attributes with the same category, as in this example:
1 CLASS_STICKY_METHOD(c, "undocumented", 0, "1");

2

3 // add some methods here with class_addmethod()

4 // the undocumented attribute for methods means that the ref-page

5 // generator will ignore these methods.

6

7 CLASS_STICKY_METHOD_CLEAR(c, "undocumented");

See also: CLASS_STICKY_METHOD_CLEAR

#define CLASS_STICKY_METHOD_CLEAR	(	c,
		name
	)

Close a CLASS_STICKY_METHOD block.

Parameters

c	The class pointer.
name	The name of the sticky attribute as a C-string.

See also: CLASS_STICKY_METHOD

#define OBJ_ATTR_ATOM	(	x,
		attrname,
		flags,
		val
	)

Create an instance-local t_atom attribute and add it to a Max class.

Parameters

x	The object pointer.
attrname	The name of this attribute as a C-string.
flags	Any flags you wish to declare for this attribute, as defined in e_max_attrflags.
val	Pointer to the value.

#define OBJ_ATTR_ATOM_ARRAY

Create an instance-local array-of-atoms attribute of fixed length, and add it to the object.

Parameters

x	The object pointer.
attrname	The name of this attribute as a C-string.
flags	Any flags you wish to declare for this attribute, as defined in e_max_attrflags.
count	The number of items in the t_atom array.
vals	Pointer to the values.

#define OBJ_ATTR_CHAR	(	x,
		attrname,
		flags,
		val
	)

Create an instance-local char attribute and add it to a Max class.

Parameters

x	The object pointer.
attrname	The name of this attribute as a C-string.
flags	Any flags you wish to declare for this attribute, as defined in e_max_attrflags.
val	Pointer to the value.

#define OBJ_ATTR_CHAR_ARRAY	(	x,
		attrname,
		flags,
		count,
		vals
	)

Create an instance-local array-of-chars attribute of fixed length, and add it to the object.

Parameters

x	The object pointer.
attrname	The name of this attribute as a C-string.
flags	Any flags you wish to declare for this attribute, as defined in e_max_attrflags.
count	The number of items in the char array.
vals	Pointer to the values.

#define OBJ_ATTR_DEFAULT	(	x,
		attrname,
		flags,
		parsestr
	)

An instance-attribute version of CLASS_ATTR_DEFAULT.

Parameters

x	The t_object instance pointer.
attrname	The name of the attribute as a C-string.
flags	Any flags you wish to declare for this new attribute, as defined in e_max_attrflags.
parsestr	A C-string, which will be parsed into an array of atoms to set the initial value.

See also: CLASS_ATTR_DEFAULT

#define OBJ_ATTR_DEFAULT_SAVE	(	x,
		attrname,
		flags,
		parsestr
	)

An instance-attribute version of CLASS_ATTR_DEFAULT_SAVE.

Parameters

x	The t_object instance pointer.
attrname	The name of the attribute as a C-string.
flags	Any flags you wish to declare for this new attribute, as defined in e_max_attrflags.
parsestr	A C-string, which will be parsed into an array of atoms to set the initial value.

See also: CLASS_ATTR_DEFAULT_SAVE

#define OBJ_ATTR_DOUBLE	(	x,
		attrname,
		flags,
		val
	)

Create an instance-local 64bit float attribute and add it to a Max class.

Parameters

x	The object pointer.
attrname	The name of this attribute as a C-string.
flags	Any flags you wish to declare for this attribute, as defined in e_max_attrflags.
val	Pointer to the value.

#define OBJ_ATTR_DOUBLE_ARRAY	(	x,
		attrname,
		flags,
		count,
		vals
	)

Create an instance-local array-of-64bit-floats attribute of fixed length, and add it to the object.

Parameters

x	The object pointer.
attrname	The name of this attribute as a C-string.
flags	Any flags you wish to declare for this attribute, as defined in e_max_attrflags.
count	The number of items in the double array.
vals	Pointer to the values.

#define OBJ_ATTR_FLOAT	(	x,
		attrname,
		flags,
		val
	)

Create an instance-local 32bit float attribute and add it to a Max class.

Parameters

x	The object pointer.
attrname	The name of this attribute as a C-string.
flags	Any flags you wish to declare for this attribute, as defined in e_max_attrflags.
val	Pointer to the value.

#define OBJ_ATTR_FLOAT_ARRAY	(	x,
		attrname,
		flags,
		count,
		vals
	)

Create an instance-local array-of-32bit-floats attribute of fixed length, and add it to the object.

Parameters

x	The object pointer.
attrname	The name of this attribute as a C-string.
flags	Any flags you wish to declare for this attribute, as defined in e_max_attrflags.
count	The number of items in the float array.
vals	Pointer to the values.

#define OBJ_ATTR_LONG	(	x,
		attrname,
		flags,
		val
	)

Create an instance-local long integer attribute and add it to a Max class.

Parameters

x	The object pointer.
attrname	The name of this attribute as a C-string.
flags	Any flags you wish to declare for this attribute, as defined in e_max_attrflags.
val	Pointer to the value.

#define OBJ_ATTR_LONG_ARRAY	(	x,
		attrname,
		flags,
		count,
		vals
	)

Create an instance-local array-of-long-integers attribute of fixed length, and add it to the object.

Parameters

x	The object pointer.
attrname	The name of this attribute as a C-string.
flags	Any flags you wish to declare for this attribute, as defined in e_max_attrflags.
count	The number of items in the long array.
vals	Pointer to the values.

#define OBJ_ATTR_OBJ	(	x,
		attrname,
		flags,
		val
	)

Create an instance-local t_object* attribute and add it to a Max class.

Parameters

x	The object pointer.
attrname	The name of this attribute as a C-string.
flags	Any flags you wish to declare for this attribute, as defined in e_max_attrflags.
val	Pointer to the value.

#define OBJ_ATTR_OBJ_ARRAY	(	x,
		attrname,
		flags,
		count,
		vals
	)

Create an instance-local array-of-objects attribute of fixed length, and add it to the object.

Parameters

x	The object pointer.
attrname	The name of this attribute as a C-string.
flags	Any flags you wish to declare for this attribute, as defined in e_max_attrflags.
count	The number of items in the t_object* array.
vals	Pointer to the values.

#define OBJ_ATTR_SAVE	(	x,
		attrname,
		flags
	)

An instance-attribute version of CLASS_ATTR_SAVE.

Parameters

x	The t_object instance pointer.
attrname	The name of the attribute as a C-string.
flags	Any flags you wish to declare for this new attribute, as defined in e_max_attrflags.

See also: CLASS_ATTR_SAVE

#define OBJ_ATTR_SYM	(	x,
		attrname,
		flags,
		val
	)

Create an instance-local t_symbol* attribute and add it to a Max class.

Parameters

x	The object pointer.
attrname	The name of this attribute as a C-string.
flags	Any flags you wish to declare for this attribute, as defined in e_max_attrflags.
val	Pointer to the value.

#define OBJ_ATTR_SYM_ARRAY	(	x,
		attrname,
		flags,
		count,
		vals
	)

Create an instance-local array-of-symbols attribute of fixed length, and add it to the object.

Parameters

x	The object pointer.
attrname	The name of this attribute as a C-string.
flags	Any flags you wish to declare for this attribute, as defined in e_max_attrflags.
count	The number of items in the t_symbol* array.
vals	Pointer to the values.

#define STRUCT_ATTR_ATOM	(	c,
		flags,
		structname,
		structmember
	)

Create a t_atom attribute and add it to a Max class.