MashModel

typedef struct _MashModel MashModel;

The MashModel structure contains only private data.

struct MashModelClass

struct MashModelClass {
};

The MashModelClass structure contains only private data.

mash_model_new ()

ClutterActor *      mash_model_new                      (void);

Constructs a new MashModel. Nothing will be rendered by the model until a MashData is attached using mash_model_set_data().

mash_model_new_from_file ()

ClutterActor *      mash_model_new_from_file            (MashDataFlags flags,
                                                         const gchar *filename,
                                                         GError **error);

This is a convenience function that creates a new MashData and immediately loads the data in filename. If the load succeeds a new MashModel will be created for the data. The model has a default white material so that if vertices of the model have any color attributes they will be used directly. The material does not have textures by default so if you want the model to be textured you will need to modify the material.

mash_model_get_material ()

CoglHandle          mash_model_get_material             (MashModel *self);

Gets the material that will be used to render the model. The material can be modified to affect the appearence of the model. By default the material will be solid white.

mash_model_set_material ()

void                mash_model_set_material             (MashModel *self,
                                                         CoglHandle material);

Replaces the material that will be used to render the model with the given one. By default a MashModel will use a solid white material. However the color of the material is still blended with the vertex colors so the white material will cause the vertex colors to be used directly. If you want the model to be textured you will need to create a material that has a texture layer and set it with this function.

If a MashLightSet is used with the model then the material given here will be modified to use the program generated by that light set. If multiple models are expected to use the same material with different light sets, it would be better to use a different copy of the same material for each set of models so that they don't repeatedly change the program on the material during paint.

mash_model_get_data ()

MashData *          mash_model_get_data                 (MashModel *self);

Gets the model data that will be used to render the actor.

mash_model_set_data ()

void                mash_model_set_data                 (MashModel *self,
                                                         MashData *data);

Replaces the data used by the actor with data. A reference is taken on data so if you no longer need it you should unref it with g_object_unref().

mash_model_get_fit_to_allocation ()

gboolean            mash_model_get_fit_to_allocation    (MashModel *self);

mash_model_set_fit_to_allocation ()

void                mash_model_set_fit_to_allocation    (MashModel *self,
                                                         gboolean fit_to_allocation);

This sets whether the actor should scale the model to fit the actor's allocation. If it's TRUE then all of the axes of the model will be scaled by the same amount to fill the allocation as much as possible without distorting the aspect ratio. The model is also translated so that it is at the center of the allocation and centered at 0 along the z axis. The size along the z axis is not considered when calculating a scale so if the model is largest along that axis then the actor may appear too large. The transformations are applied in addition to the actor's transformations so it is still possible scale the actor further using the scale-x and scale-y properties. The preferred size of the actor will be the width and height of the model. If width-for-height or height-for-width allocation is being used then MashModel will return whatever width or height will exactly preserve the aspect ratio.

If the value is FALSE then the actor is not transformed so the origin of the model will be the top left corner of the actor. The preferred size of the actor will be maximum extents of the model although the allocation is not considered during paint so if the model extends past the allocated size then it will draw outside the allocation.

The default value is TRUE.

mash_model_get_light_set ()

MashLightSet *      mash_model_get_light_set            (MashModel *self);

Since 0.2

mash_model_set_light_set ()

void                mash_model_set_light_set            (MashModel *self,
                                                         MashLightSet *light_set);

This sets the MashLightSet that will be used to render the model. Alternatively NULL can be passed to disable lighting for this model. The light set represents a collection of MashLights that will affect the appearance of the model.

Since 0.2

The "data" property

  "data"                     MashData*             : Read / Write

The MashData to render.

The "fit-to-allocation" property

  "fit-to-allocation"        gboolean              : Read / Write

Whether to transform the model so that it fills the actor's allocation while preserving the aspect ratio.

Default value: TRUE

The "light-set" property

  "light-set"                MashLightSet*         : Read / Write

The MashLightSet to use for the lighting model.

The "material" property

  "material"                 CoglHandle*           : Read / Write

The Cogl material to render with.