OpenCMISS::Zinc::Scenefiltermodule Class Reference

Module managing all scene filters. More...

#include <scenefilter.hpp>

Public Member Functions
	Scenefiltermodule (cmzn_scenefiltermodule_id in_filtermodule_id)
	Scenefiltermodule (const Scenefiltermodule &scenefiltermodule)
Scenefiltermodule &	operator= (const Scenefiltermodule &scenefiltermodule)
bool	isValid () const
cmzn_scenefiltermodule_id	getId () const
Scenefilter	createScenefilterVisibilityFlags ()
Scenefilter	createScenefilterFieldDomainType (Field::DomainType domainType)
Scenefilter	createScenefilterGraphicsName (const char *matchName)
Scenefilter	createScenefilterGraphicsType (Graphics::Type graphicsType)
Scenefilter	createScenefilterRegion (const Region &matchRegion)
ScenefilterOperator	createScenefilterOperatorAnd ()
ScenefilterOperator	createScenefilterOperatorOr ()
Scenefilter	findScenefilterByName (const char *name)
int	beginChange ()
int	endChange ()
Scenefilter	getDefaultScenefilter ()
int	setDefaultScenefilter (const Scenefilter &filter)

Protected Attributes
cmzn_scenefiltermodule_id	id

Detailed Description

Module managing all scene filters.

Module managing all scene filters.

Member Function Documentation

int OpenCMISS::Zinc::Scenefiltermodule::beginChange ( )

inline

Begin caching or increment cache level for this scene filter module. Call this function before making multiple changes to minimise number of change messages sent to clients. Must remember to end_change after completing changes. Can be nested.

See Also

Scenefiltermodule::endChange

Returns

Status OpenCMISS::Zinc::OK on success, otherwise OpenCMISS::Zinc::ERROR_ARGUMENT.

Scenefilter OpenCMISS::Zinc::Scenefiltermodule::createScenefilterFieldDomainType ( Field::DomainType  domainType )

inline

Creates and returns a scene filter which matches any graphics with given field domain type.

Parameters

domainType

The field domain type graphics attribute to be matched by this filter.

Returns

Handle to new scene filter, or NULL/invalid handle on failure.

Scenefilter OpenCMISS::Zinc::Scenefiltermodule::createScenefilterGraphicsName ( const char *  matchName )

inline

Creates a scene filter which matches any graphics with the supplied name.

Parameters

matchName

The name of a graphics must be matched by this filter.

Returns

Handle to new scene filter, or NULL/invalid handle on failure.

Scenefilter OpenCMISS::Zinc::Scenefiltermodule::createScenefilterGraphicsType ( Graphics::Type  graphicsType )

inline

Creates a scene filter which matches any graphics with matching type.

Parameters

graphicsType

The type of a graphics must be matched by this filter.

Returns

Handle to new scene filter, or NULL/invalid handle on failure.

ScenefilterOperator OpenCMISS::Zinc::Scenefiltermodule::createScenefilterOperatorAnd ( )

inline

Creates and returns a scene filter which returns the logical AND of a collective of operand filters, i.e. true if all operand filters are true.

Returns

Handle to new scene filter, or NULL/invalid handle on failure.

ScenefilterOperator OpenCMISS::Zinc::Scenefiltermodule::createScenefilterOperatorOr ( )

inline

Creates and returns a scene filter which returns the logical OR of a collective of operand filters, i.e. true if any operand filter is true.

Returns

Handle to new scene filter, or NULL/invalid handle on failure.

Scenefilter OpenCMISS::Zinc::Scenefiltermodule::createScenefilterRegion ( const Region &  matchRegion )

inline

Creates a scene filter which matches any graphics in region or any of its sub-regions.

Parameters

matchRegion

The region to be matched by this filter.

Returns

Handle to new scene filter, or NULL/invalid handle on failure.

Scenefilter OpenCMISS::Zinc::Scenefiltermodule::createScenefilterVisibilityFlags ( )

inline

Creates and returns a scene filter which matches any graphics with visibility flag set AND its owning region and all ancestor region scenes' visibility flags set i.e. scene visibility flags work hierarchically.

Returns

Handle to new scene filter, or NULL/invalid handle on failure.

int OpenCMISS::Zinc::Scenefiltermodule::endChange ( )

inline

Decrement cache level or end caching of changes for the scene filter module. Call scene filter module begin change method before making multiple changes and call this afterwards. When change level is restored to zero, cached change messages are sent out to clients.

See Also

Scenefiltermodule::beginChange

Returns

Status OpenCMISS::Zinc::OK on success, any other value on failure.

Scenefilter OpenCMISS::Zinc::Scenefiltermodule::findScenefilterByName ( const char *  name )

inline

Find the scene filter with the specified name, if any.

Parameters

name	The name of the scene filter.

Returns

Handle to scene filter, or NULL/invalid handle if not found or failed.

Scenefilter OpenCMISS::Zinc::Scenefiltermodule::getDefaultScenefilter ( )

inline

Get the default scene filter, if any.

Returns

Handle to default scene filter, or NULL/invalid handle if none or failed.

cmzn_scenefiltermodule_id OpenCMISS::Zinc::Scenefiltermodule::getId ( ) const

inline

Return the C handle of the Scenefiltermodule object.

Returns

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

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

inline

Check if this is a valid Scenefiltermodule object.

Returns

Status True if object is valid, false otherwise.

int OpenCMISS::Zinc::Scenefiltermodule::setDefaultScenefilter ( const Scenefilter &  filter )

inline

Set the default scene filter.

Parameters

filter

The scene filter to set as default.

Returns

OpenCMISS::Zinc::OK on success otherwise OpenCMISS::Zinc::ERROR_ARGUMENT.

---

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

• auto_comments_output/scenefilter.hpp