Clarisse 4.0 SP10 SDK  4.0.0.0.10
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
Public Member Functions | Protected Member Functions | List of all members
ModuleDeformer Class Reference

This class implements a Deformer object in Clarisse.
A deformer is an embedded object that modifies a geometry. More...

Inheritance diagram for ModuleDeformer:
ModuleProjectItem ModuleObject OfModule ResourceUser EventObject CoreCustomData CoreBaseObject CoreBaseType

Public Member Functions

const bool & is_local_deformation () const
 Returns whether the deformation is applied in local space or not.
 
bool deform (const CtxEval &eval_ctx, const ModuleGeometry &module, ModuleDeformerGeometry &geometry, const unsigned int &begin, const unsigned int &end) const
 Applies the deformation on a range of vertices.
 
bool pre_deform (const CtxEval &eval_ctx, const ModuleGeometry &module, ModuleDeformerTopology &topology) const
 This function calls the pre deformation callback.
 
void post_deform (const CtxEval &eval_ctx, const ModuleGeometry &module) const
 This function calls the post deformation callback.
 

Protected Member Functions

virtual void module_constructor (OfObject &object)
 
virtual void on_attribute_change (const OfAttr &attr, int &dirtiness, const int &dirtiness_flags)
 
virtual bool on_new_time (const double &time)
 

Additional Inherited Members

- Public Types inherited from EventObject
typedef void(* EventInfoFunction )(EventObject &, const EventInfo &, void *)
 
typedef void(EventObject::* EventInfoMethod )(EventObject &, const EventInfo &, void *)
 
typedef void(* EventFunction )(EventObject &, const CoreString &, void *)
 
typedef void(EventObject::* EventMethod )(EventObject &, const CoreString &, void *)
 
- Static Public Member Functions inherited from ModuleObject
static ResourceID declare_resource (const char *tag)
 
static ResourceID declare_resource (const CoreString &tag)
 
static bool declare_resource (ResourceID id, const char *tag)
 
static bool declare_resource (ResourceID id, const CoreString &tag)
 
static ResourceID get_resource_id (const char *tag)
 
static ResourceID get_resource_id (const CoreString &tag)
 
static const char * get_resource_tag (ResourceID id)
 

Detailed Description

This class implements a Deformer object in Clarisse.
A deformer is an embedded object that modifies a geometry.

Member Function Documentation

bool ModuleDeformer::deform ( const CtxEval eval_ctx,
const ModuleGeometry module,
ModuleDeformerGeometry geometry,
const unsigned int &  begin,
const unsigned int &  end 
) const

Applies the deformation on a range of vertices.

Parameters
[in]eval_ctxEvaluation context.
[in]moduleThe module of the geometry to deform.
[out]geometryThe geometry data to deform.
[in]beginIndex of the first vertex on which the deformation should be applied.
[in]endIndex of the last vertex on which the deformation should be applied.
void ModuleDeformer::post_deform ( const CtxEval eval_ctx,
const ModuleGeometry module 
) const

This function calls the post deformation callback.

Parameters
[in]eval_ctxEvaluation context.
[in]moduleThe module of the geometry that has been deformed.
bool ModuleDeformer::pre_deform ( const CtxEval eval_ctx,
const ModuleGeometry module,
ModuleDeformerTopology topology 
) const

This function calls the pre deformation callback.

Parameters
[in]eval_ctxEvaluation context.
[in]geometryThe module of the geometry to deform.
[out]topologyThe topology of the data to deform.