Paradox Game Engine  v1.0.0 beta06
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Events Macros Pages
Classes | Public Member Functions | Static Public Member Functions | Properties | List of all members
SiliconStudio.Quantum.ModelNodePath Class Reference

A class describing the path of a node, relative to a root node. The path can cross references, array, etc. More...

Public Member Functions

IModelNode GetNode ()
 Gets the node corresponding to this path. More...
 
override string ToString ()
 

Static Public Member Functions

static ModelNodePath GetPath (IModelNode rootNode, IModelNode target)
 Gets a new instance of ModelNodePath corresponding to the path of the given target node relative to the given root node. More...
 

Properties

bool IsValid [get]
 Gets whether this path is a valid path. More...
 
IModelNode RootNode [get, set]
 Gets the root node of this path. More...
 

Detailed Description

A class describing the path of a node, relative to a root node. The path can cross references, array, etc.

Definition at line 14 of file ModelNodePath.cs.

Member Function Documentation

IModelNode SiliconStudio.Quantum.ModelNodePath.GetNode ( )

Gets the node corresponding to this path.

Returns
The node corresponding to this path.
Exceptions
InvalidOperationExceptionThe path is invalid.

Definition at line 54 of file ModelNodePath.cs.

References SiliconStudio.Quantum.IModelNode.Content, and IsValid().

static ModelNodePath SiliconStudio.Quantum.ModelNodePath.GetPath ( IModelNode  rootNode,
IModelNode  target 
)
static

Gets a new instance of ModelNodePath corresponding to the path of the given target node relative to the given root node.

Parameters
rootNodeThe root node of the path.
targetThe target node of the path.
Returns
A new instance of the ModelNodePath. This instance may not be valid if no path lead to the target node from the root node.

Definition at line 90 of file ModelNodePath.cs.

override string SiliconStudio.Quantum.ModelNodePath.ToString ( )

Definition at line 103 of file ModelNodePath.cs.

References IsValid().

Property Documentation

bool SiliconStudio.Quantum.ModelNodePath.IsValid
get

Gets whether this path is a valid path.

Definition at line 42 of file ModelNodePath.cs.

Referenced by SiliconStudio.Presentation.Quantum.ValueChangedActionItem.ValueChangedActionItem().

IModelNode SiliconStudio.Quantum.ModelNodePath.RootNode
getset

Gets the root node of this path.

Definition at line 47 of file ModelNodePath.cs.

The documentation for this class was generated from the following file: