MASH_DATA_ERROR

#define MASH_DATA_ERROR mash_data_error_quark ()

Error domain for MashData errors

MashData

typedef struct _MashData MashData;

The MashData structure contains only private data.

MashDataClass

typedef struct {
} MashDataClass;

The MashDataClass structure contains only private data.

enum MashDataError

typedef enum
  {
    MASH_DATA_ERROR_PLY,
    MASH_DATA_ERROR_MISSING_PROPERTY,
    MASH_DATA_ERROR_INVALID,
    MASH_DATA_ERROR_UNSUPPORTED
  } MashDataError;

Error enumeration for MashData

enum MashDataFlags

typedef enum
  {
    MASH_DATA_NONE = 0,
    MASH_DATA_NEGATE_X = 1,
    MASH_DATA_NEGATE_Y = 2,
    MASH_DATA_NEGATE_Z = 4
  } MashDataFlags;

Flags used for modifying the data as it is loaded. These can be passed to mash_data_load().

If any of the negate flags are set then they cause the vertex and normal coordinates for the specified axis to be negated. This could be useful when loading a model from a tool which uses a different coordinate system than the one used in your application. For example, in Blender if the view is rotated such that the x-axis is pointing to the right, and the z-axis is pointing out of the screen then y-axis would be pointing directly up. However in Clutter the default transformation is set up such that the y-axis would be pointing down. Therefore if a model is loaded from Blender it would appear upside-down. Also all of the front faces would be in clockwise order. If backface culling is then enabled then the wrong faces would be culled with the default Cogl settings.

To avoid these issues when exporting from Blender it is common to pass the MASH_DATA_NEGATE_Y flag.

mash_data_new ()

MashData *          mash_data_new                       (void);

Constructs a new MashData instance. The object initially has no data so nothing will be drawn when mash_data_render() is called. To load data into the object, call mash_data_load().

mash_data_load ()

gboolean            mash_data_load                      (MashData *self,
                                                         MashDataFlags flags,
                                                         const gchar *filename,
                                                         GError **error);

Loads the data from the PLY file called filename into self. The model can then be rendered using mash_data_render(). If there is an error loading the file it will return FALSE and error will be set to a GError instance.

mash_data_render ()

void                mash_data_render                    (MashData *self);

Renders the data contained in the PLY model to the Clutter scene. The current Cogl source material will be used to affect the appearance of the model. This function is not usually called directly but instead the MashData instance is added to a MashModel and this function will be automatically called by the paint method of the model.

mash_data_get_extents ()

void                mash_data_get_extents               (MashData *self,
                                                         ClutterVertex *min_vertex,
                                                         ClutterVertex *max_vertex);

Gets the bounding cuboid of the vertices in self. The cuboid is represented by two vertices representing the minimum and maximum extents. The x, y and z components of min_vertex will contain the minimum x, y and z values of all the vertices and max_vertex will contain the maximum. The extents of the model are cached so it is cheap to call this function.