Orxonox: OIS::Envelope Class Reference

# OIS::Envelope Class Reference

`#include <src/ois/OISEffect.h>`

Inheritance diagram for OIS::Envelope:

List of all members.

## Public Member Functions

| Envelope ()
bool | isUsed ()

## Public Attributes

unsigned short | attackLength
unsigned short | attackLevel
unsigned short | fadeLength
unsigned short | fadeLevel

## Detailed Description

An optional envelope to be applied to the start/end of an effect. If any of these values are nonzero, then the envelope will be used in setting up the effect. Not currently utilised.. But, will be soon.

## Constructor & Destructor Documentation

OIS::Envelope::Envelope | ( |  | ) | `[inline]`

## Member Function Documentation

bool OIS::Envelope::isUsed | ( |  | ) | `[inline]`

## Member Data Documentation

unsigned short OIS::Envelope::attackLength

unsigned short OIS::Envelope::attackLevel

unsigned short OIS::Envelope::fadeLength

unsigned short OIS::Envelope::fadeLevel

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

- src/ois/OISEffect.h