OpenCMISS-Zinc C++ API Documentation
Public Member Functions | List of all members
OpenCMISS::Zinc::ScenefilterOperator Class Reference

An operator OR or AND specific scene filter type. More...

#include <scenefilter.hpp>

Inheritance diagram for OpenCMISS::Zinc::ScenefilterOperator:
OpenCMISS::Zinc::Scenefilter

Public Member Functions

 ScenefilterOperator (cmzn_scenefilter_operator_id operator_filter_id)
 
cmzn_scenefilter_operator_id getDerivedId ()
 
int appendOperand (const Scenefilter &operand)
 
Scenefilter getFirstOperand ()
 
Scenefilter getNextOperand (const Scenefilter &refOperand)
 
bool isOperandActive (const Scenefilter &operand)
 
int setOperandActive (const Scenefilter &operand, bool isActive)
 
int insertOperandBefore (const Scenefilter &operand, const Scenefilter &refOperand)
 
int removeOperand (const Scenefilter &operand)
 
- Public Member Functions inherited from OpenCMISS::Zinc::Scenefilter
 Scenefilter (cmzn_scenefilter_id in_filter_id)
 
 Scenefilter (const Scenefilter &scenefilter)
 
Scenefilteroperator= (const Scenefilter &scenefilter)
 
bool isValid () const
 
cmzn_scenefilter_id getId () const
 
bool isManaged ()
 
int setManaged (bool value)
 
bool evaluateGraphics (const Graphics &graphics)
 
bool isInverse ()
 
int setInverse (bool value)
 
char * getName ()
 
int setName (const char *name)
 
ScenefilterOperator castOperator ()
 

Additional Inherited Members

- Protected Attributes inherited from OpenCMISS::Zinc::Scenefilter
cmzn_scenefilter_id id
 

Detailed Description

An operator OR or AND specific scene filter type.

An operator OR or AND specific scene filter type. Note that these are n-ary operators, able to take any number of operands, and that each operand can be individually set active or inactive, permitting them to be used as high level visibility lists.

Member Function Documentation

int OpenCMISS::Zinc::ScenefilterOperator::appendOperand ( const Scenefilter operand)
inline

Adds operand to the end of the list of operands for the operator filter. If operand is already in the list, it is moved to the end. Fails if operand depends on the operator filter.

Parameters
operandThe filter to be added
Returns
Status OpenCMISS::Zinc::OK on success, any other value on failure.
cmzn_scenefilter_operator_id OpenCMISS::Zinc::ScenefilterOperator::getDerivedId ( )
inline

Return the C handle of the derived ScenefilterOperator object.

Returns
C handle of the derived ScenefilterOperator if this objects is valid, 0 otherwise.
Scenefilter OpenCMISS::Zinc::ScenefilterOperator::getFirstOperand ( )
inline

Get the first operand filter in the operator filter's list of operands.

Returns
Handle to first operand scene filter, or NULL/invalid handle if none or failed.
Scenefilter OpenCMISS::Zinc::ScenefilterOperator::getNextOperand ( const Scenefilter refOperand)
inline

Get the next filter after <ref_operand> in the operator filter's list of operands.

Parameters
refOperandThe filter to be referenced
Returns
Handle to next operand scene filter, or NULL/invalid handle if none or failed.
int OpenCMISS::Zinc::ScenefilterOperator::insertOperandBefore ( const Scenefilter operand,
const Scenefilter refOperand 
)
inline

Insert a filter before ref_operand in the list of operands for the operator filter. If the operand is already in the list of operands it is moved to the new location. Fails if operand depends on the operator filter.

Parameters
operandThe operand filter to be inserted.
refOperandThe reference filter to insert before.
Returns
Status OpenCMISS::Zinc::OK on success, any other value on failure.
bool OpenCMISS::Zinc::ScenefilterOperator::isOperandActive ( const Scenefilter operand)
inline

Check whether operand is active in the operator filter.

Parameters
operandThe filter to be checked.
Returns
Boolean true if operand is valid and active, otherwise false.
int OpenCMISS::Zinc::ScenefilterOperator::removeOperand ( const Scenefilter operand)
inline

Remove a filter from the list of operands in an operator filter.

Parameters
operandThe filter to be removed.
Returns
Status OpenCMISS::Zinc::OK on success, any other value on failure.
int OpenCMISS::Zinc::ScenefilterOperator::setOperandActive ( const Scenefilter operand,
bool  isActive 
)
inline

Set an operand in the operator filter to be active or inactive.

Parameters
operandThe filter to be set.
isActiveValue to set: true to mark as active, false for inactive.
Returns
Status OpenCMISS::Zinc::OK on success, any other value on failure.

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