AlPerformance

Interface to Alias performance options.

Synopsis

#include <AlPerformance.h>

class AlPerformance

enum AlPrecisionType {

kActual,

kScreenSize,

kMedium,

kLow,

kConnectedPoints,

kBoundary,

kBoundingBox

};

static AlPrecisionType redrawPrecision( void );

static void setRedrawPrecision( AlPrecisionType );

static AlPrecisionType motionPrecision( void );

static void setMotionPrecision( AlPrecisionType );

static boolean drawTrimBoundaries( void );

static void setDrawTrimBoundaries( boolean );

static boolean trimBoundariesDuringPlayback( void );

static void setTrimBoundariesDuringPlayback( boolean );

static boolean expressionsAfterModification( void );

static void setExpressionsAfterModification( boolean );

static boolean expressionsDuringXform( void );

static void setExpressionsDuringXform( boolean );

static boolean expressionsDuringPlayback( void );

static void setExpressionsDuringPlayback( boolean );

static boolean constraintsAfterModification( void );

static void setConstraintsAfterModification( boolean );

static boolean constraintsDuringXform( void );

static void setConstraintsDuringXform( boolean );

static boolean constraintsDuringPlayback( void );

static void setConstraintsDuringPlayback( boolean );

static boolean ikAfterModification( void );

static void setIkAfterModification( boolean );

static boolean ikDuringXform( void );

static void setIkDuringXform( boolean );

static boolean ikDuringPlayback( void );

static void setIkDuringPlayback( boolean );

static boolean constructionHistoryAfterModification( void );

static void setConstructionHistoryAfterModification( boolean );

static boolean constructionHistoryDuringXform( void );

static void setConstructionHistoryDuringXform( boolean );

static boolean constructionHistoryDuringPlayback( void );

static void setConstructionHistoryDuringPlayback( boolean );

static boolean blendDuringPlayback( void );

static void setBlendDuringPlayback( boolean );

static boolean constructionHistoryRound( void );

static void setConstructionHistoryRound( boolean );

static boolean actionWindowAfterModification( void );

static void setActionWindowAfterModification( boolean );

static boolean actionWindowDuringXform( void );

static void setActionWindowDuringXform( boolean );

static boolean displayablesAfterModification( void );

static void setDisplayablesAfterModification( boolean );

static boolean displayablesDuringXform( void );

static void setDisplayablesDuringXform( boolean );

static boolean displayablesDuringPlayback( void );

static void setDisplayablesDuringPlayback( boolean );

Description

This class encapsulates all access to the Alias performance options. Every value in the window can be retrieved and set.

Summary

AlPerformance::AlPrecisionType AlPerformance::redrawPrecision( void )

Description

Returns the redraw precision.

Return Codes

AlPerformance::kScreenSize

AlPerformance::kActual

void AlPerformance::setRedrawPrecision( AlPrecisionType t )

Description

Sets the redraw precision to one of the following modes:

AlPerformance::kScreenSize - precision of objects reduces as they become smaller

AlPerformance::kActual - objects are drawn with the curve precision option

Arguments

t - the new redraw precision

AlPerformance::AlPrecisionType AlPerformance::motionPrecision( void )

Description

Returns the motion precision type.

Return Codes

AlPerformance::kScreenSize

AlPerformance::kMedium

AlPerformance::kLow

AlPerformance::kConnectedPoints

AlPerformance::kBoundary

AlPerformance::kBoundingBox

AlPerformance::kActual

void AlPerformance::setMotionPrecision( AlPrecisionType t )

Description

Sets the redraw precision to one of the following modes:

AlPerformance::kScreenSize - reduces the precision of the objects as they become smaller

AlPerformance::kMedium - reduces the default precision

AlPerformance::kLow - significantly reduces the default precision

AlPerformance::kConnectedPoints - draws the objects by connecting edit points

AlPerformance::kBoundary - draws the outer boundary of the object

AlPerformance::kBoundingBox - draws the boundary box of the object

AlPerformance::kActual - draws objects with the curve precision option

Arguments

t - the new redraw precision

int AlPerformance::evaluationsPerUpdate( void )

Description

Returns current value of evaluation density. The value should be in [1, 10].

void AlPerformance::setEvaluationsPerUpdate( int i )

Description

Sets the value of evaluation density. The value should be in [1, 10].

boolean AlPerformance::drawTrimBoundaries( void )

Description

Returns TRUE if trim boundaries are drawn during updates.

void AlPerformance::setDrawTrimBoundaries( boolean b )

Description

Selects if trim boundaries are drawn during updates.

Arguments

b - TRUE if trim boundaries are to be drawn

boolean AlPerformance::trimBoundariesDuringPlayback( void )

Description

Returns TRUE if trim boundaries are drawn during playback.

void AlPerformance::setTrimBoundariesDuringPlayback( boolean b )

Description

Selects if trim boundaries are drawn during playback.

Arguments

b - TRUE if trim boundaries are to be drawn

boolean AlPerformance::expressionsAfterModification( void )

Description

Returns TRUE if expressions are evaluated after modifications.

void AlPerformance::setExpressionsAfterModification( boolean b )

Description

Selects if expressions are evaluated after modifications.

Arguments

b - TRUE if expressions are to be evaluated

boolean AlPerformance::expressionsDuringXform( void )

Description

Returns TRUE if expressions are evaluated during transformations.

void AlPerformance::setExpressionsDuringXform( boolean b )

Description

Selects if expressions are evaluated during transformations.

Arguments

b - TRUE if expressions are to be evaluated

boolean AlPerformance::expressionsDuringPlayback( void )

Description

Returns TRUE if expressions are evaluated during playback.

void AlPerformance::setExpressionsDuringPlayback( boolean b )

Description

Selects if expressions are evaluated during playback.

Arguments

b - TRUE if expressions are to be evaluated

boolean AlPerformance::constraintsAfterModification( void )

Description

Returns TRUE if constraints are updated after modifications.

void AlPerformance::setConstraintsAfterModification( boolean b )

Description

Selects if constraints are updated after modifications.

Arguments

b - TRUE if constraints are updated

boolean AlPerformance::constraintsDuringXform( void )

Description

Returns TRUE if constraints are updated during transformations.

void AlPerformance::setConstraintsDuringXform( boolean b )

Description

Selects if constraints are updated during transformations.

Arguments

b - TRUE if constraints are updated

boolean AlPerformance::constraintsDuringPlayback( void )

Description

Returns TRUE if constraints are updated during playback.

void AlPerformance::setConstraintsDuringPlayback( boolean b )

Description

Selects if constraints are updated during playback.

Arguments

b - TRUE if constraints are updated

boolean AlPerformance::ikAfterModification( void )

Description

Returns TRUE if IK are updated after modifications.

void AlPerformance::setIkAfterModification( boolean b )

Description

Selects if IK are updated after modifications.

Arguments

b - TRUE if IK are updated

boolean AlPerformance::ikDuringXform( void )

Description

Returns TRUE if IK are updated during transformations.

void AlPerformance::setIkDuringXform( boolean b )

Description

Selects if IK are updated during transformations.

Arguments

b - TRUE if IK are updated

boolean AlPerformance::ikDuringPlayback( void )

Description

Returns TRUE if IK are updated during playback.

void AlPerformance::setIkDuringPlayback( boolean b )

Description

Selects if IK are updated during playback.

Arguments

b - TRUE if IK are updated

boolean AlPerformance::constructionHistoryAfterModification( void )

Description

Returns TRUE if construction history updates occur after modifications.

void AlPerformance::setConstructionHistoryAfterModification( boolean b )

Description

Selects if construction history updates occur after modifications.

Arguments

b - TRUE if construction history updates occur

boolean AlPerformance::constructionHistoryDuringXform( void )

Description

Returns TRUE if construction history updates occur during transformations.

void AlPerformance::setConstructionHistoryDuringXform( boolean b )

Description

Selects if construction history updates occur during transformations.

Arguments

b - TRUE if construction history updates occur

boolean AlPerformance::constructionHistoryDuringPlayback( void )

Description

Returns TRUE if construction history updates occur during playback.

void AlPerformance::setConstructionHistoryDuringPlayback( boolean b )

Description

Selects if construction history updates occur during playback.

Arguments

b - TRUE if construction history updates occur

boolean AlPerformance::blendDuringPlayback( void )

Description

Returns TRUE if blend updates occur during playback.

void AlPerformance::setBlendDuringPlayback( boolean b )

Description

Selects if blend updates occur during playback.

Arguments

b - TRUE if blend updates occur

boolean AlPerformance::constructionHistoryRound( void )

Description

Returns TRUE if construction history round updates occur.

void AlPerformance::setConstructionHistoryRound( boolean b )

Description

Selects if construction history round updates occur.

Arguments

b - TRUE if construction history round updates occur

boolean AlPerformance::actionWindowAfterModification( void )

Description

Returns TRUE if action window updates occur after modifications.

void AlPerformance::setActionWindowAfterModification( boolean b )

Description

Selects if action window updates occur after modifications.

Arguments

b - TRUE if action window updates occur

boolean AlPerformance::actionWindowDuringXform( void )

Description

Returns TRUE if action window updates occur during transformations.

void AlPerformance::setActionWindowDuringXform( boolean b )

Description

Selects if action window updates occur during transformations.

Arguments

b - TRUE if action window updates occur

boolean AlPerformance::displayablesAfterModification( void )

Description

Returns TRUE if displayables updates occur after modifications. Displayables are objects such as locators.

void AlPerformance::setDisplayablesAfterModification( boolean b )

Description

Selects if displayables updates occur after modifications. Displayables are objects such as locators.

Arguments

b - TRUE if displayables updates occur

boolean AlPerformance::displayablesDuringXform( void )

Description

Returns TRUE if displayables updates occur during transformations. Displayables are objects such as locators.

void AlPerformance::setDisplayablesDuringXform( boolean b )

Description

Selects if displayables updates occur during transformations. Displayables are objects such as locators.

Arguments

b - TRUE if displayables updates occur

boolean AlPerformance::displayablesDuringPlayback( void )

Description

Returns TRUE if displayables updates occur during animation playback. Displayables are objects such as locators.

void AlPerformance::setDisplayablesDuringPlayback( boolean b )

Description

Selects if displayables updates occur during animation playback. Displayables are objects such as locators.

Arguments

b - TRUE if displayables updates occur