CicmWrapper
A wrapper for Pure Data
 All Data Structures Files Functions Variables Enumerations Enumerator Macros Modules
Modules | Data Structures | Typedefs | Functions
The Object Part

The eobj part. More...

Modules

 The DSP Object Part
 The edspobj part.
 

Data Structures

struct  t_eobj
 The CICM object. More...
 

Typedefs

typedef struct t_eobj t_eobj
 

Functions

void * eobj_new (t_eclass *c)
 The eobj creation function. More...
 
void eobj_free (void *x)
 The eobj deletion function. More...
 
t_eproxyeobj_proxynew (void *x)
 Adds a proxy inlet to an eobj. More...
 
int eobj_getproxy (void *x)
 Retreives the index of the proxy that received the last message. More...
 
t_eclasseobj_getclass (void *x)
 Retrieves the eclass of an eobj. More...
 
t_symbol * eobj_getclassname (void *x)
 Retrieves the classe name of an eobj. More...
 
t_canvas * eobj_getcanvas (void *x)
 Retreives the canvas that owns the eobj. More...
 
char eobj_isbox (void *x)
 Retreives if an eobj is a GUI box or not. More...
 
char eobj_isdsp (void *x)
 Retreives if an eobj is a DSP object or not. More...
 

Detailed Description

The eobj part.

This part refers to the methods and structures that can be used by all the eobjs.

Function Documentation

void eobj_free ( void *  x)

The eobj deletion function.

Detach the eobj from Pure Data and free the proxy inlets.

Parameters
xThe eobj pointer
t_canvas* eobj_getcanvas ( void *  x)

Retreives the canvas that owns the eobj.

Directly access to the canvas structure of the eobj.

Parameters
xThe eobj pointer.
Returns
This function returns a pointer the canvas that owns the eobj.
t_eclass* eobj_getclass ( void *  x)

Retrieves the eclass of an eobj.

Directly access to the eclass structure of the eobj.

Parameters
xThe eobj pointer.
Returns
This function returns a pointer to the eclass of the eobj.
t_symbol* eobj_getclassname ( void *  x)

Retrieves the classe name of an eobj.

Directly access to the name of the eclass of the eobj.

Parameters
xThe eobj pointer.
Returns
This function returns the name of the class of the eobj.
int eobj_getproxy ( void *  x)

Retreives the index of the proxy that received the last message.

Retreives the current proxy index. This function should only be used while a message has been received.

Parameters
xThe eobj pointer.
Returns
This function return the index of the current proxy.
char eobj_isbox ( void *  x)

Retreives if an eobj is a GUI box or not.

Check if the box flag is postive or null.

Parameters
xThe eobj pointer.
Returns
This function returns 1 if the eobj is a GUI and 0 if not.
char eobj_isdsp ( void *  x)

Retreives if an eobj is a DSP object or not.

Check if the dsp method has been initialized.

Parameters
xThe eobj pointer.
Returns
This function returns 1 if the eobj is a DSP object and 0 if not.
void* eobj_new ( t_eclass c)

The eobj creation function.

Allocate the memory for an intance of an eobj of a specific eclass, intialize the defaults values and methods.

Parameters
cThe eclass pointer.
Returns
This function returns a pointer to a new instance of an eobj.
t_eproxy* eobj_proxynew ( void *  x)

Adds a proxy inlet to an eobj.

Allocates and initializes a new proxy inlet.

Parameters
xThe eobj pointer.
Returns
This function returns a pointer to the new proxy inlet.