OpenCMISS::Zinc::Fieldmoduleevent Class Reference

Information about changes to fields and other objects in the field module. More...

#include <fieldmodule.hpp>

Public Member Functions
	Fieldmoduleevent (cmzn_fieldmoduleevent_id in_fieldmodule_event_id)
	Fieldmoduleevent (const Fieldmoduleevent &fieldmoduleEvent)
Fieldmoduleevent &	operator= (const Fieldmoduleevent &fieldmoduleEvent)
bool	isValid () const
cmzn_fieldmoduleevent_id	getId () const
Field::ChangeFlags	getFieldChangeFlags (const Field &field) const
Meshchanges	getMeshchanges (const Mesh &mesh) const
Nodesetchanges	getNodesetchanges (const Nodeset &nodeset) const
Field::ChangeFlags	getSummaryFieldChangeFlags () const

Protected Attributes
cmzn_fieldmoduleevent_id	id

Detailed Description

Information about changes to fields and other objects in the field module.

Information about changes to fields and other objects in the field module, sent with each callback from the fieldmodule notifier.

Member Function Documentation

Field::ChangeFlags OpenCMISS::Zinc::Fieldmoduleevent::getFieldChangeFlags ( const Field &  field ) const

inline

Get logical OR of flags indicating how the field has changed.

See also

Field::ChangeFlag

Parameters

field

The field to query about.

Returns

The change flags summarising the change: logical OR of enum Field::ChangeFlag values. Returns CMZN_FIELD_CHANGE_FLAG_NONE in case of invalid arguments.

cmzn_fieldmoduleevent_id OpenCMISS::Zinc::Fieldmoduleevent::getId ( ) const

inline

Return the C handle of the Fieldmoduleevent object.

Returns

C handle of Fieldmoduleevent if this objects is valid, 0 otherwise.

Meshchanges OpenCMISS::Zinc::Fieldmoduleevent::getMeshchanges ( const Mesh &  mesh ) const

inline

Get object describing changes to elements in a mesh including elements involved in partial change to fields. Note that changes to nodes are propagated to elements referencing them, and changes to parent elements are propagated to their faces. The logic for this is conservative e.g. it assumes all fields use all nodes, so you may sometimes get false notification of changes.

Parameters

mesh	The mesh to get change information for.

Returns

Handle to mesh changes, or NULL/invalid handle on failure.

Nodesetchanges OpenCMISS::Zinc::Fieldmoduleevent::getNodesetchanges ( const Nodeset &  nodeset ) const

inline

Get object describing changes to nodes in a nodeset including nodes involved in partial change to field.

Parameters

nodeset

The nodeset to get change information for.

Returns

Handle to nodeset changes, or NULL/invalid handle on failure.

Field::ChangeFlags OpenCMISS::Zinc::Fieldmoduleevent::getSummaryFieldChangeFlags ( ) const

inline

Get logical OR of flags indicating how fields in the field module have changed.

See also

Field::ChangeFlag

Returns

The change flags summarising the change: logical OR of enum Field::ChangeFlag values.

bool OpenCMISS::Zinc::Fieldmoduleevent::isValid ( ) const

inline

Check if this is a valid Fieldmoduleevent object.

Returns

Status True if object is valid, false otherwise.

---

The documentation for this class was generated from the following file:

• auto_comments_output/fieldmodule.hpp