DAZ Script 2: DzProperty Class Reference

void DzProperty::beginEdit ( )

When beginEdit is called, the property will create an undo item.

Boolean DzProperty::canAnimate ( )

Returns:: true if it is legal to animate this property.

DzProperty::canAnimateChanged ( Boolean enabled ) [signal]

Signature: "canAnimateChanged(bool)"

Emitted when animation for this property is enabled or disabled.

Parameters:

enabled

If true, animation was enabled for the property, otherwise, animation was diasbled.

void DzProperty::cancelEdit ( )

Finish the edit operation but cancel any changes.

void DzProperty::copyFrom ( DzProperty prop )

Copies the value(s) of the given property into this property.

DzPropertyClipboard DzProperty::copyToClipboard ( )

Copies the value(s) of the property to a 'clipboard' so that they may be saved and applied (copied) to another property - or to the same property. Subclasses should reimplement this function if they contain implementation specific data that needs to be copied.

Returns:: The 'clipboard' which holds a copy of the current property's value(s). These values are a snapshot of the current state of the property, and will remain unchanged even if the property is changed or deleted. The caller is responsible for deleting this object.

DzProperty::currentValueChanged ( ) [signal]

Signature: "currentValueChanged()"

Emitted when the value of this property at the current time has changed. If the current time changes and this property has animation data, this signal is emitted as appropriate.

void DzProperty::deleteAllKeys ( )

Deletes all keys on this property.

Number DzProperty::deleteKeys	(	Number	start,
		Number	end
	)

Deletes all keys starting at index start and ending at index end. User is responsible to assure proper ranges for key indexes.

Returns:: The number of keys deleted.

Number DzProperty::deleteKeys ( DzTimeRange interval )

Clears key values within the given range, including the endpoints.

Returns:: The number of keys actually deleted.

int DzProperty::deleteSelectedKeys ( )

Deletes all selected keys.

Returns:: The number of keys actually removed.

void DzProperty::finishEdit ( )

When finishEdit is called the undo item will be finalized and pushed on to the stack.

void DzProperty::getAttributes ( DzPropertySettings settings )

Populates the given settings object with the attributes of this property.

DzController DzProperty::getController ( Number idx )

Returns:: The i'th controller on this property

Array DzProperty::getControllerList ( )

Provided for use by DAZ Script - plug-in developers should use the much more efficient controllerListIterator() function.

Returns:: A list of the controllers on this property

DzPropertyGroup DzProperty::getGroup ( )

Returns:: The property group that this belongs to, or NULL if none.

Number DzProperty::getKeyIndexRange	(	DzTimeRange	iv,
		Number	start
	)

Returns:: The number of keys that lie in the given range, including the endpoints of the range. Also returns the index of the first key in the range.

DzTimeRange DzProperty::getKeyRange ( )

Returns:: The total range of keys.

DzTime DzProperty::getKeyTime ( Number i )

Returns:: The time of the i'th key. The index i must be in the current key range.

String DzProperty::getLabel ( )

Returns:: The user-defined label for this property

Number DzProperty::getNumControllers ( )

Returns:: The number of controllers for this property

Number DzProperty::getNumKeys ( DzTimeRange range )

Returns:: The number of keys that lie within the given range, including endpoints.

Number DzProperty::getNumKeys ( )

Returns:: The total number of keys.

Number DzProperty::getNumSelectedKeys ( )

Returns:: The number of currently selected keys.

DzElement DzProperty::getOwner ( )

Returns:: The current owner of this property

String DzProperty::getPath ( )

Returns:: A string that represents the complete property path (with grouping), delimited with '/' characters.

DzTimeRange DzProperty::getSelectedKeyRange ( )

Returns:: A range that encompasses all currently selected keys.

String DzProperty::getWidgetClass ( )

Returns:: The class name of the widget to use to display this property to the user. Subclasses should reimplement this method to return the class name of the widget to use.

DzProperty::groupChanged ( DzPropertyGroup newGroup ) [signal]

Signature: "groupChanged(DzPropertyGroup*)"

Emitted when the group this property is in changed.

Parameters:

newGroup

The group this property was added to

Boolean DzProperty::hasControllers ( )

Returns:: true if this property has controllers, false if not.

Boolean DzProperty::hasKeys ( )

Returns:: true if this property has key data.

DzProperty::hiddenChanged ( Boolean hidden ) [signal]

Signature: "hiddenChanged(bool)"

Emitted when the hidden state of this property is changed.

Parameters:

hidden

true if the property is currently hidden in the interface.

Boolean DzProperty::isFavorite ( )

Returns:: true if the property is a favorite.

DzProperty::isFavoriteChanged ( Boolean onOff ) [signal]

Signature: "isFavoriteChanged(bool)"

Emitted when this property is set or unset as a favorite.

Parameters:

onOff

If true, the property is now a favorite, otherwise, the property is no longer a favorite.

Boolean DzProperty::isGlobalFavorite ( )

Returns:: true if the property is a global favorite.

DzProperty::isGlobalFavoriteChanged ( Boolean onOff ) [signal]

Signature: "isGlobalFavoriteChanged(bool)"

Emitted when this property is set or unset as a global favorite.

Parameters:

onOff

If true, the property is now a global favorite, otherwise, the property is no longer a global favorite.

Boolean DzProperty::isHidden ( )

Returns:: true if this property should not be shown in the interface.

Boolean DzProperty::isKey	(	DzTime	t,
		Number	index
	)

Returns:: true if there is a key at the given time. Also returns the index of the key in the key array, if any.

Boolean DzProperty::isKeySelected ( Number i )

Returns:: true if the key at the given index is selected.

Boolean DzProperty::isLocked ( )

Returns:: true if this property is locked.

Boolean DzProperty::isManipulator ( )

Returns:: true if the property is a manipulator.

DzProperty::isManipulatorChanged ( Boolean isManip ) [signal]

Signature: "isManipulatorChanged(bool)"

Emitted when this property is set or unset as a manipulator.

Parameters:

isManip

If true, the property is now a manipulator, otherwise, the property is no longer a manipulator.

Boolean DzProperty::isNumeric ( )

Returns:: true if this property can be retrieved/set as a scalar numeric value.

Boolean DzProperty::isPrivateProperty ( )

Returns:: true if this property is private.

Boolean DzProperty::isRigProperty ( )

Returns:: true if this property is for rigging.

Boolean DzProperty::isSelected ( )

Returns:: true if the property is selected.

Boolean DzProperty::isUserProperty ( )

Returns:: true if this property can be deleted.

DzProperty::isUserPropertyChanged ( Boolean isUserProp ) [signal]

Signature: "isUserPropertyChanged(bool)"

Emitted when this property is set or unset as a user property.

Parameters:

isUserProp

If true, the property is now a user property, otherwise, the property is no longer a user property.

DzProperty::keySelectionChanged ( DzTimeRange range ) [signal]

Signature: "keySelectionChanged(const DzTimeRange&)"

Emitted when the selection state of this property's keys has changed.

Parameters:

range

The range in which selection changed.

DzProperty::labelChanged ( String newLabel ) [signal]

Signature: "labelChanged(const QString&)"

Emitted when the label of this property is changed.

Parameters:

newLabel

The new label of this property.

void DzProperty::lock ( Boolean onOff )

Locks/Unlocks this property. When locked, a property will not accept new key values or changes to current key values.

DzProperty::lockStateChanged ( ) [signal]

Signature: "lockStateChanged()"

Emitted when the lock state of this property has changed.

Boolean DzProperty::moveControllertoIndex	(	DzController	ctrl,
		Number	newIdx
	)

Moves the controller ctrl to location newIdx

Parameters:

	ctrl	The controller to remove
	newIdx	The index to move the controller to. If < 0 the controller will be moved to the beginning of the list. If >= DzProperty::getNumControllers(), the controller will be moved to the end of the list

Returns:: true if the move was successful, false otherwise

Boolean DzProperty::moveControllerToIndex	(	Number	curIdx,
		Number	newIdx
	)

Moves the controller at location curIdx to location newIdx

Parameters:

	curIdx	The index of the controller to move. If < 0 or >= DzProperty::getNumControllers() this method will return false
	newIdx	The index to move the controller to. If < 0 the controller will be moved to the beginning of the list. If >= DzProperty::getNumControllers(), the controller will be moved to the end of the list

Returns:: true if the move was successful, false otherwise

void DzProperty::removeAllControllers ( )

Removes all controllers from this property.

void DzProperty::removeController ( DzProperty prop )

Removes the controller that references the given property.

void DzProperty::removeController ( DzController ctrl )

Removes the given controller from this property.

void DzProperty::removeController ( Number idx )

Removes the controller at the given index from this property.

DzProperty::removed ( ) [signal]

Signature: "removed()"

Emitted when this property is removed.

void DzProperty::selectAllKeys ( Boolean onOff = true )

Select or deselect all keys.

Returns:: The number of keys whose state was changed.

DzProperty::selectionStateChanged ( ) [signal]

Signature: "selectionStateChanged()"

Emitted when this property is selected or deselected.

void DzProperty::selectKey	(	Number	i,
		Boolean	onOff = `true`
	)

Selects/deselects the i'th key.

void DzProperty::selectKeys	(	DzTimeRange	range,
		Boolean	onOff
	)

Sets the seletion state of any keys in the given range.

Returns:: The number of keys whose selection state changed.

void DzProperty::setAttributes ( DzPropertySettings settings )

Sets attributes for this property.

void DzProperty::setCanAnimate ( Boolean yesNo )

Sets whether this property is animatable. Should only called to set initial values on a property that has been created using the default constructor. Should not be called otherwise.

void DzProperty::setHidden ( Boolean yesNo )

Hide or show this property in the interface.

void DzProperty::setIsFavorite ( Boolean onOff )

Sets whether or not the property is a favorite.

void DzProperty::setIsGlobalFavorite ( Boolean onOff )

Sets whether or not the property is a global favorite.

void DzProperty::setIsManipulator ( Boolean onOff )

Sets whether or not the property is a manipulator.

void DzProperty::setIsRigProperty ( Boolean yesNo )

Sets whether this property is a rigging property. Should only called to set initial values on a property that has been created using the default constructor. Should not be called otherwise.

void DzProperty::setIsUserProperty ( Boolean yesNo )

Sets whether this property is a user property (i.e. can be deleted). Should only called to set initial values on a property that has been created using the default constructor. Should not be called otherwise.

void DzProperty::setLabel ( String label )

Sets the label that the user sees for this property. Must be unique among all the other properties of this property's owner.

void DzProperty::setPath ( String path )

Sets the group that this property will belong to based on the given full path.

void DzProperty::setSelected ( Boolean onOff )

Sets whether or not the property is selected.

DzProperty::valueChanged ( DzTimeRange range ) [signal]

Signature: "valueChanged(const DzTimeRange&)"

Emitted when the value of this property is changed.

Parameters:

range

The range over which the property has changed

DzProperty Class Reference
[Property Objects]

Methods

Signals

Detailed Description

Member Function Documentation

Copyright © 2002 - 2009 DAZ 3D, Inc.


Methods
void	beginEdit ()
Boolean	canAnimate ()
void	cancelEdit ()
void	copyFrom (DzProperty prop)
DzPropertyClipboard	copyToClipboard ()
void	deleteAllKeys ()
Number	deleteKeys (Number start, Number end)
Number	deleteKeys (DzTimeRange interval)
Number	deleteSelectedKeys ()
void	finishEdit ()
void	getAttributes (DzPropertySettings settings)
DzController	getController (Number idx)
Array	getControllerList ()
DzPropertyGroup	getGroup ()
Number	getKeyIndexRange (DzTimeRange iv, Number start)
DzTimeRange	getKeyRange ()
DzTime	getKeyTime (Number i)
String	getLabel ()
Number	getNumControllers ()
Number	getNumKeys (DzTimeRange range)
Number	getNumKeys ()
Number	getNumSelectedKeys ()
DzElement	getOwner ()
String	getPath ()
DzTimeRange	getSelectedKeyRange ()
String	getWidgetClass ()
Boolean	hasControllers ()
Boolean	hasKeys ()
Boolean	isFavorite ()
Boolean	isGlobalFavorite ()
Boolean	isHidden ()
Boolean	isKey (DzTime t, Number index)
Boolean	isKeySelected (Number i)
Boolean	isLocked ()
Boolean	isManipulator ()
Boolean	isNumeric ()
Boolean	isPrivateProperty ()
Boolean	isRigProperty ()
Boolean	isSelected ()
Boolean	isUserProperty ()
void	lock (Boolean onOff)
Boolean	moveControllertoIndex (DzController ctrl, Number newIdx)
Boolean	moveControllerToIndex (Number curIdx, Number newIdx)
void	removeAllControllers ()
void	removeController (DzProperty prop)
void	removeController (DzController ctrl)
void	removeController (Number idx)
Number	selectAllKeys (Boolean onOff=true)
void	selectKey (Number i, Boolean onOff=true)
Number	selectKeys (DzTimeRange range, Boolean onOff)
void	setAttributes (DzPropertySettings settings)
void	setCanAnimate (Boolean yesNo)
void	setHidden (Boolean yesNo)
void	setIsFavorite (Boolean onOff)
void	setIsGlobalFavorite (Boolean onOff)
void	setIsManipulator (Boolean onOff)
void	setIsRigProperty (Boolean yesNo)
void	setIsUserProperty (Boolean yesNo)
void	setLabel (String label)
void	setPath (String path)
void	setSelected (Boolean onOff)
Signals
void	canAnimateChanged (Boolean enabled)
	Signature: `"canAnimateChanged(bool)"`
void	currentValueChanged ()
	Signature: `"currentValueChanged()"`
void	groupChanged (DzPropertyGroup newGroup)
	Signature: `"groupChanged(DzPropertyGroup*)"`
void	hiddenChanged (Boolean hidden)
	Signature: `"hiddenChanged(bool)"`
void	isFavoriteChanged (Boolean onOff)
	Signature: `"isFavoriteChanged(bool)"`
void	isGlobalFavoriteChanged (Boolean onOff)
	Signature: `"isGlobalFavoriteChanged(bool)"`
void	isManipulatorChanged (Boolean isManip)
	Signature: `"isManipulatorChanged(bool)"`
void	isUserPropertyChanged (Boolean isUserProp)
	Signature: `"isUserPropertyChanged(bool)"`
void	keySelectionChanged (DzTimeRange range)
	Signature: `"keySelectionChanged(const DzTimeRange&)"`
void	labelChanged (String newLabel)
	Signature: `"labelChanged(const QString&)"`
void	lockStateChanged ()
	Signature: `"lockStateChanged()"`
void	removed ()
	Signature: `"removed()"`
void	selectionStateChanged ()
	Signature: `"selectionStateChanged()"`
void	valueChanged (DzTimeRange range)
	Signature: `"valueChanged(const DzTimeRange&)"`

DzProperty Class Reference [Property Objects]

Methods

Signals

Detailed Description

Member Function Documentation

Copyright © 2002 - 2009 DAZ 3D, Inc.

DzProperty Class Reference
[Property Objects]