Paradox Game Engine  v1.0.0 beta06
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Events Macros Pages
SiliconStudio.Quantum.References.IReference Interface Reference
Inheritance diagram for SiliconStudio.Quantum.References.IReference:
IEquatable< IReference > SiliconStudio.Quantum.References.ObjectReference SiliconStudio.Quantum.References.ReferenceEnumerable

Public Member Functions

void Clear ()
 Clear the reference, making it represent a null or empty object. More...
 
void Refresh (object newObjectValue)
 Refresh this reference and its nested references. More...
 
bool UpdateTarget (ModelContainer modelContainer)
 Updates the target node of this reference or its nested references from a ModelContainer. More...
 

Properties

object ObjectValue [get]
 Gets the data object targeted by this reference, if available. More...
 
Type Type [get]
 Gets the type of object targeted by this reference, if available. More...
 
object Index [get]
 Gets the index of this reference in its parent collection. If the reference is not in a collection, this will return Reference.NotInCollection. More...
 

Detailed Description

Definition at line 7 of file IReference.cs.

Member Function Documentation

void SiliconStudio.Quantum.References.IReference.Clear ( )

Clear the reference, making it represent a null or empty object.

Implemented in SiliconStudio.Quantum.References.ReferenceEnumerable, and SiliconStudio.Quantum.References.ObjectReference.

void SiliconStudio.Quantum.References.IReference.Refresh ( object  newObjectValue)

Refresh this reference and its nested references.

Implemented in SiliconStudio.Quantum.References.ReferenceEnumerable, and SiliconStudio.Quantum.References.ObjectReference.

bool SiliconStudio.Quantum.References.IReference.UpdateTarget ( ModelContainer  modelContainer)

Updates the target node of this reference or its nested references from a ModelContainer.

Parameters
modelContainerA ModelContainer in which the corresponding model node may have been registered.
Returns
true if the model node was found in the ModelContainer and the target nodes has been updated, false otherwise.

Implemented in SiliconStudio.Quantum.References.ReferenceEnumerable, and SiliconStudio.Quantum.References.ObjectReference.

Property Documentation

object SiliconStudio.Quantum.References.IReference.Index
get

Gets the index of this reference in its parent collection. If the reference is not in a collection, this will return Reference.NotInCollection.

Definition at line 22 of file IReference.cs.

object SiliconStudio.Quantum.References.IReference.ObjectValue
get

Gets the data object targeted by this reference, if available.

Definition at line 12 of file IReference.cs.

Type SiliconStudio.Quantum.References.IReference.Type
get

Gets the type of object targeted by this reference, if available.

Definition at line 17 of file IReference.cs.


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