Configure state objects in a state. More...

Inheritance diagram for StateObject:

Collaboration diagram for StateObject:

Properties
State	State `[get]`
	Gets the state of the selected state object.

string	TargetObjectPath `[get, set]`
	Gets or sets the path to the node to which Kanzi applies the state of the selected state object.

Properties inherited from StateBase
IEnumerable< Property >	ValueProperties `[get]`

Properties inherited from NodeComponentHost
IEnumerable< NodeComponent >	NodeComponents `[get]`
	Gets the node components in a NodeComponentHost.

IEnumerable< TriggerNodeComponent >	Triggers `[get]`
	Gets the triggers in a NodeComponentHost.

Properties inherited from ProjectItem
IEnumerable< ProjectItem >	Children `[get]`
	Gets all child items of a project item.

string	IconLocation `[get]`
	Gets the location of the icon for this project item in Kanzi Studio.

object	IconModifier `[get, set]`
	Gets or sets the icon modifier for this project item.

string	InvalidityReason `[get]`
	Gets the reason why this project item is in an invalid state, or null if the item is valid.

bool	IsDeleted `[get]`
	Gets whether this project item has been deleted.

bool	IsDisposed `[get]`
	Gets whether this project item has been disposed.

bool	IsHidden `[get, set]`
	Gets or sets whether this project item is hidden in Kanzi Studio.

bool	IsReadOnly `[get, set]`
	Gets or sets whether this project item is read-only.

bool	IsValidState `[get]`
	Gets whether this project item is in a valid state.

string	KzbUrl `[get]`
	Gets the kzb URL of a project item.

string	Name `[get, set]`
	Gets or sets the name of a project item.

ProjectItem	Parent `[get, set]`
	Gets or sets the parent of this project item.

string	Path `[get]`
	Gets the path to this project item within the project.

Project	Project `[get]`
	Gets the project in which this item is located.

Type	ProjectItemType `[get]`
	Gets the type of this project item.

PropertyTypeLibrary	PropertyTypeLibrary `[get]`
	Gets the Property Types library of the project of this item which stores all property types you create in a Kanzi Studio project.

ProjectItemProperties	PropertyTypes `[get]`

object	this[Property property] `[get, set]`
	Gets or sets the value of the specified property on this project item.

object	this[string propertyName] `[get, set]`
	Gets or sets the value of the property with the specified name on this project item.

string	ToolTip `[get]`
	Gets the tooltip text for this project item in Kanzi Studio.

string	TypeDisplayName `[get]`
	Gets the type of a project item.

Properties inherited from PropertyContainer
IEnumerable< Property >	Properties `[get]`
	Gets the properties in a project item or node component.

Properties inherited from BindingHost
IEnumerable< Binding >	Bindings `[get]`
	Gets the bindings in a BindingHost.

Additional Inherited Members
Public Member Functions inherited from NodeComponentHost
NodeComponent	CreateNodeComponent (NodeComponent sourceNodeComponent)
	Creates a node component by copying an existing node component.

NodeComponent	CreateNodeComponent (string name, NodeComponentType nodeComponentType)
	Creates a node component (Animation, Input Manipulator, or Custom node component).

TriggerNodeComponent	CreateTrigger (NodeComponentType triggerType)
	Creates a trigger.

TriggerNodeComponent	CreateTrigger (TriggerNodeComponent sourceTrigger)
	Creates a trigger by copying an existing trigger.

bool	DeleteNodeComponent (NodeComponent nodeComponent)
	Deletes a node component.

bool	DeleteTrigger (TriggerNodeComponent trigger)
	Deletes a trigger.

Public Member Functions inherited from ProjectItem
void	AddProperty (Property property)
	Adds a property to an item.

void	AddProperty (string propertyName)
	Adds a property to an item.

void	BeginBatchModification (string batchName)
	Begins a batch modification operation.

bool	CanAddProperty (Property property)
	Checks whether Kanzi Studio allows you to add a specific property to an item.

bool	CanAddProperty (string propertyName)
	Checks whether Kanzi Studio allows you to add a specific property to an item.

void	CommitBatchModification ()
	Commits the current batch modification operation.

bool	Delete ()
	Deletes a project item.

void	DeregisterThumbnailUser (object user)
	Deregisters a registerd thumbnail user.

IEnumerable< Property >	GetAddableProperties ()
	Gets a list of properties which you can add to an item.

T	GetAncestor< T > ()
	Gets the nearest item of given type in the parent tree.

ProjectItem	GetChild (string childName)
	Gets the child item of the current item with the given name.

T	GetChild< T > (string childName)
	Gets the child item of the current item with the given name and type.

int	GetChildIndex (ProjectItem child)
	Gets the index of a child project item within this item's children collection.

IEnumerable< Property >	GetContextProperties ()
	Gets the context properties for this project item.

IEnumerable< Property >	GetFixedProperties ()
	Gets the fixed properties for this project item that cannot be removed.

IEnumerable< Property >	GetFrequentlyAddedProperties ()
	Gets the properties that are frequently added to this type of project item.

ProjectItem	GetProjectItemByPath (string path)
	Gets a project item by its path relative to this project item.

string	GetRelativeProjectPathTo (ProjectItem anotherItem)
	Gets the relative path from this project item to another project item.

IEnumerable< Property >	GetRemovableProperties ()
	Gets a list of properties which you can remove from an item.

BitmapSource	GetThumbnail (int width, int height, bool showChildren, bool showFullScreen, Node contextNode)
	Gets the thumbnail image for a project item.

BitmapSource	GetThumbnail (int width, int height, bool showChildren, bool showFullScreen, Node contextNode, float[] letterboxColorRGBA)
	Gets the thumbnail image for a project item.

IEnumerable< ProjectItem >	GetTreeItemsAsList ()
	Enumerates the items under this ProjectItem including this item itself, children, and grand children.

bool	HasProperty (Property property)
	Checks whether an item has a specific property.

bool	HasProperty (string propertyName)
	Checks whether an item has a specific property.

bool	IsPropertyReadOnly (Property property)
	Checks whether the specified property is read-only on this project item.

void	RegisterThumbnailUser (object user, uint width, uint height, bool showChildren, bool showFullScreen, Node contextNode)
	Registers a user for the thumbnail images for a project item.

void	RemoveProperty (Property property)
	Removes a property from an item.

void	RemoveProperty (string propertyName)
	Removes a property from an item.

void	SetChildIndex (ProjectItem child, int index)
	Sets the index of a child project item within this item's children collection.

void	SetPropertyReadOnlyStatus (Property property, bool? value)
	Sets the read-only status of the specified property on this project item.

void	UpdateValidity ()
	Recalculates the validity the item.

Public Member Functions inherited from PropertyContainer
object	Get (Property property)
	Gets the value of a property.

object	Get (string propertyName)
	Gets the value of a property.

T	Get< T > (TypedProperty< T > property)
	Gets the value of a property.

void	Set (string propertyName, object value)
	Sets the value of a property.

void	Set< T > (TypedProperty< T > property, T value)
	Sets the value of a property.

Public Member Functions inherited from ChildContainer
string	GenerateUniqueChildName (string defaultName)
	Generates a unique name.

string	GetInvalidityReasonOfNewName (string newName)
	Returns the reason why the passed name is not valid.

Public Member Functions inherited from BindingHost
Binding	CreateBinding (Binding sourceBinding)
	Creates a binding by copying an existing binding.

Binding	CreateBinding (Property property, AnimationTargetPropertyAttributeEnum attribute, string code, BindingTypeEnum bindingMode, NodeReferenceBase pushTarget)
	Creates and configures a binding.

Binding	CreateBinding (Property property, AnimationTargetPropertyAttributeEnum attribute, string code, BindingTypeEnum bindingMode=BindingTypeEnum.ONE_WAY)
	Creates and configures a One Way binding.

void	DeleteBinding (Binding binding)
	Deletes a binding.

Events inherited from ProjectItem
EventHandler< CollectionChangedEventArgs< ProjectItem > >	ChildCollectionChanged
	Occurs when the children collection of this project item changes.

EventHandler< DeletedEventArgs >	Deleted
	Occurs after this project item has been deleted.

EventHandler< DeletedEventArgs >	Deleting
	Occurs when this project item is about to be deleted.

EventHandler< CollectionChangedEventArgs< ProjectItem > >	DescendantChildCollectionChanged
	Occurs when the children collection of this project item or any of its descendants changes.

EventHandler< DeletedEventArgs >	DescendantDeleted
	Occurs after a descendant of this project item has been deleted.

EventHandler< DynamicPropertyChangedEventArgs >	DescendantDynamicPropertyChanged
	Occurs when a dynamic property value changes on this project item or any of its descendants.

EventHandler< ParentChangedEventArgs >	DescendantParentChanged
	Occurs when the parent of this project item or any of its descendants changes.

EventHandler< CollectionChangedEventArgs< string > >	DescendantPropertyCollectionChanged
	Occurs when a property is added to or removed from this project item or any of its descendants.

EventHandler< ProjectItemEventArgs >	Disposing
	Occurs when this project item is being disposed.

EventHandler< DynamicPropertyChangedEventArgs >	DynamicPropertyChanged
	Occurs when a dynamic property value changes on this project item.

EventHandler< ParentChangedEventArgs >	ParentChanged
	Occurs when the parent of this project item changes.

EventHandler< PathChangedEventArgs >	PathChanged
	Occurs when the path of this project item changes.

EventHandler< DynamicPropertyChangedEventArgs >	PreviewDescendantDynamicPropertyChanged
	Occurs before a dynamic property value changes on this project item or any of its descendants.

EventHandler< DynamicPropertyChangedEventArgs >	PreviewDynamicPropertyChanged
	Occurs before a dynamic property value changes on this project item.

EventHandler< CollectionChangedEventArgs< string > >	PropertyCollectionChanged
	Occurs when a property is added to or removed from this project item.

EventHandler< ReplaceEventArgs >	Replacing
	Occurs when this project item is being replaced.

EventHandler	ThumbnailChanged
	Occurs when the thumbnail of this project item changes.

EventHandler	ValidityChanged
	Occurs when the validity state of this project item changes.

Detailed Description

Configure state objects in a state.

State objects define the properties of nodes for a specific state. For example, you can assign a state manager to a Button 3D node which contains a Model node that defines the look of the button. State object sets the properties in the Model node using Target Object Path (Model).

See also: State, StateGroup, StateTransition, ProjectItem, Project.StateManagerLibrary

Property Documentation

◆ State

State State

get

Gets the state of the selected state object.

The state of this state object.

◆ TargetObjectPath

string TargetObjectPath

getset

Gets or sets the path to the node to which Kanzi applies the state of the selected state object.

The path to the node.

Examples

To set the path of the node to which Kanzi applies the state:

        public void Execute(PluginCommandParameter parameter)
        {
            // Get the State Managers library which stores state managers used in a Kanzi Studio project.
            var stateManagerLibrary = studio.ActiveProject.StateManagerLibrary;
            // Create a state manager named MyStateManager in the State Managers library.
            var myStateManager = studio.ActiveProject.CreateProjectItem<StateManager>(
                stateManagerLibrary.GenerateUniqueChildName("MyStateManager"), stateManagerLibrary);
            // Create a state group named MyStateGroup in the MyStateManager state manager.
            var myStateGroup = studio.ActiveProject.CreateProjectItem<StateGroup>(
                myStateManager.GenerateUniqueChildName("MyStateGroup"),
                myStateManager);
            // Create a state named MyState in the MyStateGroup state group.
            var myState = studio.ActiveProject.CreateProjectItem<State>(
                myStateGroup.GenerateUniqueChildName("MyState"),
                myStateGroup);
            // Create a state object named MyStateObject in MyState state.
            var myStateObject = studio.ActiveProject.CreateProjectItem<StateObject>(
                myState.GenerateUniqueChildName("MyStateObject"),
                myState);
            // Apply the MyState state to the Image node inside the Contacts node.
            myStateObject.TargetObjectPath = "./Contacts/Image";
        }

Properties

Additional Inherited Members

Detailed Description

Property Documentation

◆ State

◆ TargetObjectPath