Macros | Functions
Generic 3D Object Descriptions

Macros

#define EVAS_CANVAS3D_OBJECT_CLASS   evas_canvas3d_object_class_get()
 Evas 3D canvas object class.
 
#define EVAS_CANVAS3D_OBJECT_EVENT_CLICKED   (&(_EVAS_CANVAS3D_OBJECT_EVENT_CLICKED))
 Clicked Event. More...
 
#define EVAS_CANVAS3D_OBJECT_EVENT_COLLISION   (&(_EVAS_CANVAS3D_OBJECT_EVENT_COLLISION))
 Collision Event. More...
 

Functions

EOAPI void evas_canvas3d_object_change (Eo *obj, Evas_Canvas3D_State state, Evas_Canvas3D_Object *ref)
 Notify the object regarding its state change. More...
 
EOAPI Evas_Canvas3D_Object_Type evas_canvas3d_object_type_get (const Eo *obj)
 Returns the type of the object. More...
 
EOAPI void evas_canvas3d_object_type_set (Eo *obj, Evas_Canvas3D_Object_Type type)
 Sets the type of the object. More...
 
EOAPI Eina_Bool evas_canvas3d_object_dirty_get (const Eo *obj, Evas_Canvas3D_State state)
 Returns the status of a particular state of the object. More...
 
EOAPI void evas_canvas3d_object_update (Eo *obj)
 Update request for the object.
 
EOAPI void evas_canvas3d_object_update_notify (Eo *obj)
 Pure virtual update_notify function. More...
 
EOAPI void evas_canvas3d_object_change_notify (Eo *obj, Evas_Canvas3D_State state, Evas_Canvas3D_Object *ref)
 Pure virtual change_notify function. More...
 
EOAPI void evas_canvas3d_object_callback_register (Eo *obj, const char *event, const void *data)
 Pure virtual register samrt callback function. More...
 
EOAPI void evas_canvas3d_object_callback_unregister (Eo *obj, const char *event)
 Pure virtual unregister smart callback function. More...
 

Detailed Description

The Evas_Canvas3D_Object structure is an abstract base for other Evas 3D objects (scenes, nodes, lights, meshes, textures, and materials) with reference counting and propagation of modifications via reference tracking. This permits, for example, when a scene object is modified (marked dirty), a number of image objects rendering that object to be notified to update themselves, without needing to call update functions manually.

Macro Definition Documentation

◆ EVAS_CANVAS3D_OBJECT_EVENT_CLICKED

#define EVAS_CANVAS3D_OBJECT_EVENT_CLICKED   (&(_EVAS_CANVAS3D_OBJECT_EVENT_CLICKED))

Clicked Event.

Returns
Evas_Canvas3D_Node *

◆ EVAS_CANVAS3D_OBJECT_EVENT_COLLISION

#define EVAS_CANVAS3D_OBJECT_EVENT_COLLISION   (&(_EVAS_CANVAS3D_OBJECT_EVENT_COLLISION))

Collision Event.

Returns
Evas_Canvas3D_Node *

Function Documentation

◆ evas_canvas3d_object_change()

EOAPI void evas_canvas3d_object_change ( Eo obj,
Evas_Canvas3D_State  state,
Evas_Canvas3D_Object *  ref 
)

Notify the object regarding its state change.

Parameters
[in]objThe object.
[in]stateState that is changed.
[in]refThe Object that caused the change.

◆ evas_canvas3d_object_type_get()

EOAPI Evas_Canvas3D_Object_Type evas_canvas3d_object_type_get ( const Eo obj)

Returns the type of the object.

Parameters
[in]objThe object.
Returns
Object type

◆ evas_canvas3d_object_type_set()

EOAPI void evas_canvas3d_object_type_set ( Eo obj,
Evas_Canvas3D_Object_Type  type 
)

Sets the type of the object.

Parameters
[in]objThe object.
[in]typeObject type

◆ evas_canvas3d_object_dirty_get()

EOAPI Eina_Bool evas_canvas3d_object_dirty_get ( const Eo obj,
Evas_Canvas3D_State  state 
)

Returns the status of a particular state of the object.

Parameters
[in]objThe object.
[in]stateState whose status is being asked.
Returns
true if the status is dirty, false otherwise

◆ evas_canvas3d_object_update_notify()

EOAPI void evas_canvas3d_object_update_notify ( Eo obj)

Pure virtual update_notify function.

Update request for the object.

Parameters
[in]objThe object.

◆ evas_canvas3d_object_change_notify()

EOAPI void evas_canvas3d_object_change_notify ( Eo obj,
Evas_Canvas3D_State  state,
Evas_Canvas3D_Object *  ref 
)

Pure virtual change_notify function.

Update request for the object.

Parameters
[in]objThe object.
[in]stateState that is changed.
[in]refThe Object that caused the change.

◆ evas_canvas3d_object_callback_register()

EOAPI void evas_canvas3d_object_callback_register ( Eo obj,
const char *  event,
const void *  data 
)

Pure virtual register samrt callback function.

Parameters
[in]objThe object.
[in]eventEvent type.
[in]dataUser data.

◆ evas_canvas3d_object_callback_unregister()

EOAPI void evas_canvas3d_object_callback_unregister ( Eo obj,
const char *  event 
)

Pure virtual unregister smart callback function.

Parameters
[in]objThe object.
[in]eventEvent type.