DzExpressionInput Class Reference
[Property Objects]

A property input for a DzExpression. More...

Inheritance diagram for DzExpressionInput:

DzBase QObject Object List of all members.

Signals

void currentValueChanged ()
 Signature: "currentValueChanged()"
void labelChanged (String label)
 Signature: "labelChanged(const QString&)"
void propertyDeleted (DzProperty prop)
 Signature: "propertyDeleted(DzProperty*)"
void sourcePropertyRemoved (DzProperty prop)
 Signature: "sourcePropertyRemoved(DzProperty*)"

Public Member Functions

 DzExpressionInput (DzNumericProperty prop, String label)
 DzExpressionInput ()
DzNumericProperty getCurrentProperty ()
String getLabel ()
DzNumericProperty getProperty ()
Number getValue (DzTime tm)
void setLabel (String label)
void setProperty (DzNumericProperty prop)

Public Attributes

Boolean autoOverride

Detailed Description

A property input for a DzExpression.

This class specifies an input property that is used as a variable in an expression. Inputs to an expression must be explicitly declared - this enables automatic reevaluation of the expression when the values of the input properties have changed. This class associates a property with a variable name that is available in the expression.


Constructor & Destructor Documentation

DzExpressionInput::DzExpressionInput (  ) 

Default Constructor. Creates an invalid input with no property or label.

DzExpressionInput::DzExpressionInput ( DzNumericProperty  prop,
String  label 
)

Creates a new input with the given property and label.

Parameters:
prop The property that defines the value of the input.
label The variable name that this input will be available by in the expression.


Member Function Documentation

void DzExpressionInput::currentValueChanged (  )  [signal]

Signature: "currentValueChanged()"

Emitted when the current value for the input has changed.

DzNumericProperty DzExpressionInput::getCurrentProperty (  ) 

Returns:
The property that is currently acting as the input property. Typically, this will return the same value as getProperty(), however, if autoOverride is enabled, and the property's owner is 'Fit To' another node, this will return the property on fit to node that this input has been redirected to.

QString DzExpressionInput::getLabel (  ) 

Returns:
The label for the input. This also serves as the variable name that this input provides for the expression.

DzNumericProperty DzExpressionInput::getProperty (  ) 

Returns:
The linked property.

Number DzExpressionInput::getValue ( DzTime  tm  ) 

Returns:
The value of the property for this input at the given time in a DAZ Script-portable format.

void DzExpressionInput::labelChanged ( String  label  )  [signal]

Signature: "labelChanged(const QString&)"

Emitted when the label of the input has changed.

void DzExpressionInput::propertyDeleted ( DzProperty  prop  )  [signal]

Signature: "propertyDeleted(DzProperty*)"

Emitted when the source property or current property is deleted.

void DzExpressionInput::setLabel ( String  label  ) 

Set the label for the input. The label is used as the variable name that makes this input available in the expression.

Parameters:
label The new label for this input.

void DzExpressionInput::setProperty ( DzNumericProperty  prop  ) 

Set the property that provides the value for the input.

Parameters:
prop A pointer to the property for this input.

void DzExpressionInput::sourcePropertyRemoved ( DzProperty  prop  )  [signal]

Signature: "sourcePropertyRemoved(DzProperty*)"

Emitted when the source property has been removed from its owner.


Member Data Documentation

bool DzExpressionInput::autoOverride

This property determines whether or not the input will automatically be redirected when its owner is fit to another figure.


Generated on Thu Sep 24 12:21:12 2009

Copyright © 2002 - 2009 DAZ 3D, Inc.