CrystalSpace

Public API Reference

CS::Utility::iModifiableConstraintBounded Struct Reference

A bounded constraint forces the value of a parameter to either stay under a certain value, over a certain value, or between two values. More...

#include <iutil/modifiable.h>

Inheritance diagram for CS::Utility::iModifiableConstraintBounded:

List of all members.

Public Member Functions

virtual csVariantGetMaximum () const =0
 Get the maximum value of this parameter.
virtual csVariantGetMinimum () const =0
 Get the minimum value of this parameter.
virtual bool HasMaximum () const =0
 Get whether or not the value of this parameter has a maximum value.
virtual bool HasMinimum () const =0
 Get whether or not the value of this parameter has a minimum value.

Detailed Description

A bounded constraint forces the value of a parameter to either stay under a certain value, over a certain value, or between two values.

See also:
CS::Utility::ModifiableConstraintBounded for a default implementation

Definition at line 349 of file modifiable.h.


Member Function Documentation

virtual csVariant& CS::Utility::iModifiableConstraintBounded::GetMaximum (  )  const [pure virtual]

Get the maximum value of this parameter.

The behavior is undefined if HasMaximum() doesn't return true.

virtual csVariant& CS::Utility::iModifiableConstraintBounded::GetMinimum (  )  const [pure virtual]

Get the minimum value of this parameter.

The behavior is undefined if HasMinimum() doesn't return true.

virtual bool CS::Utility::iModifiableConstraintBounded::HasMaximum (  )  const [pure virtual]

Get whether or not the value of this parameter has a maximum value.

virtual bool CS::Utility::iModifiableConstraintBounded::HasMinimum (  )  const [pure virtual]

Get whether or not the value of this parameter has a minimum value.


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

Generated for Crystal Space 2.1 by doxygen 1.6.1