Paradox Game Engine  v1.0.0 beta06
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Events Macros Pages
SiliconStudio.Quantum.INodeBuilder Interface Reference

This interface provides objects and methods to build a nodal view model from a given object. More...

Inherited by SiliconStudio.Quantum.DefaultModelBuilder.

Public Member Functions

IModelNode Build (object obj, Type type, Guid rootGuid)
 Build the node hierarchy corresponding to the given object and fill the ReferenceContents list with references created during this process. More...
 

Properties

ICollection< Type > PrimitiveTypes [get]
 Gets the collection of structure types that represents custom primitive types. Primitive structures won't have node created for each of their members. More...
 
ICollection< INodeCommandAvailableCommands [get]
 Gets the collection of available commands to attach to nodes. More...
 
IEnumerable< IContentReferenceContents [get]
 Gets the enumerable of content that have references created during the last execution of the builder visitor. More...
 

Events

EventHandler
< NodeConstructingArgs
NodeConstructing
 Raised when a node is about to be constructed. The construction can be cancelled by setting NodeConstructingArgs.Discard to true. More...
 
EventHandler< NodeConstructedArgsNodeConstructed
 Raised when a node has been constructed. Allows to attach associated data to the node via the NodeConstructedArgs.AssociatedData dictionary. More...
 

Detailed Description

This interface provides objects and methods to build a nodal view model from a given object.

Definition at line 14 of file INodeBuilder.cs.

Member Function Documentation

IModelNode SiliconStudio.Quantum.INodeBuilder.Build ( object  obj,
Type  type,
Guid  rootGuid 
)

Build the node hierarchy corresponding to the given object and fill the ReferenceContents list with references created during this process.

Parameters
objThe object. Can be null.
typeThe type of the object
rootGuidThe Guid To assign to the root node.
Returns
The root node of the node hierarchy corresponding to the given object.

Property Documentation

ICollection<INodeCommand> SiliconStudio.Quantum.INodeBuilder.AvailableCommands
get

Gets the collection of available commands to attach to nodes.

Definition at line 25 of file INodeBuilder.cs.

ICollection<Type> SiliconStudio.Quantum.INodeBuilder.PrimitiveTypes
get

Gets the collection of structure types that represents custom primitive types. Primitive structures won't have node created for each of their members.

Default .NET primitive types, string and enum are always considered to be primitive type.

Definition at line 20 of file INodeBuilder.cs.

IEnumerable<IContent> SiliconStudio.Quantum.INodeBuilder.ReferenceContents
get

Gets the enumerable of content that have references created during the last execution of the builder visitor.

Definition at line 30 of file INodeBuilder.cs.

Event Documentation

EventHandler<NodeConstructedArgs> SiliconStudio.Quantum.INodeBuilder.NodeConstructed

Raised when a node has been constructed. Allows to attach associated data to the node via the NodeConstructedArgs.AssociatedData dictionary.

Definition at line 40 of file INodeBuilder.cs.

EventHandler<NodeConstructingArgs> SiliconStudio.Quantum.INodeBuilder.NodeConstructing

Raised when a node is about to be constructed. The construction can be cancelled by setting NodeConstructingArgs.Discard to true.

Definition at line 35 of file INodeBuilder.cs.


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