keyreduc.h File Reference

#include "coreexp.h"
#include "maxheap.h"
#include "interval.h"

Classes
class	KeyReduceStatus

Macros
#define	DEFULAT_KEYREDUCE_THRESHOLD   (0.5f)

Enumerations
enum	KeyReduceResult : int { KEYREDUCE_ABORT = -1 , KEYREDUCE_STOP = 0 , KEYREDUCE_CONTINUE = 1 }

Functions
CoreExport KeyReduceResult	ApplyKeyReduction (Control *cont, Interval range, float thresh, TimeValue step, KeyReduceStatus *status)
	Attempts to delete keys that lie within the given time range.

Macro Definition Documentation

DEFULAT_KEYREDUCE_THRESHOLD

#define DEFULAT_KEYREDUCE_THRESHOLD   (0.5f)

Enumeration Type Documentation

KeyReduceResult

enum KeyReduceResult : int

Enumerator
KEYREDUCE_ABORT
KEYREDUCE_STOP
KEYREDUCE_CONTINUE

{
    KEYREDUCE_ABORT = -1,   // Stops processing and undoes any key reduction
    KEYREDUCE_STOP = 0,     // Stops processing, but keeps any reduction done so far
    KEYREDUCE_CONTINUE = 1, // Keeps going.
};

Function Documentation

ApplyKeyReduction()

CoreExport KeyReduceResult ApplyKeyReduction	(	Control *	cont,
		Interval	range,
		float	thresh,
		TimeValue	step,
		KeyReduceStatus *	status
	)

Attempts to delete keys that lie within the given time range.

Parameters

cont	The controller whose keys are to be reduced.
range	The time range within which to delete keys.
thresh	After the key reduction, the controller's values at each step are guaranteed to be within this distance from their original values.
step	The controller will be sampled in steps of this time increment.
status	The callback object used to report the key reduction status and control continued processing.