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

A class representing an enumeration of references to multiple objects. More...

Inheritance diagram for SiliconStudio.Quantum.References.ReferenceEnumerable:
SiliconStudio.Quantum.References.IReference IEnumerable< ObjectReference > IEquatable< IReference >

Public Member Functions

void Clear ()
 Clear the reference, making it represent a null or empty object. More...
 
bool ContainsIndex (object index)
 Indicates whether this instance of ReferenceEnumerable contains an element which as the given index. 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.
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.
More...
 
IEnumerator< ObjectReferenceGetEnumerator ()
 
bool Equals (IReference other)
 
override string ToString ()
 

Properties

object ObjectValue [get, set]
 
Type Type [get, set]
 
object Index [get, set]
 
bool IsDictionary [get]
 Gets whether this reference enumerates a dictionary collection. More...
 
int Count [get]
 
ObjectReference this[object index] [get]
 
- Properties inherited from SiliconStudio.Quantum.References.IReference
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

A class representing an enumeration of references to multiple objects.

Definition at line 16 of file ReferenceEnumerable.cs.

Member Function Documentation

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

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

Implements SiliconStudio.Quantum.References.IReference.

Definition at line 59 of file ReferenceEnumerable.cs.

bool SiliconStudio.Quantum.References.ReferenceEnumerable.ContainsIndex ( object  index)

Indicates whether this instance of ReferenceEnumerable contains an element which as the given index.

Parameters
indexThe index to look for.
Returns
true if an object with the given index exists in this instance, false otherwise.

Definition at line 69 of file ReferenceEnumerable.cs.

bool SiliconStudio.Quantum.References.ReferenceEnumerable.Equals ( IReference  other)

Definition at line 119 of file ReferenceEnumerable.cs.

IEnumerator<ObjectReference> SiliconStudio.Quantum.References.ReferenceEnumerable.GetEnumerator ( )

Definition at line 107 of file ReferenceEnumerable.cs.

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

Refresh this reference and its nested references.

Implements SiliconStudio.Quantum.References.IReference.

Definition at line 75 of file ReferenceEnumerable.cs.

override string SiliconStudio.Quantum.References.ReferenceEnumerable.ToString ( )

Definition at line 126 of file ReferenceEnumerable.cs.

bool SiliconStudio.Quantum.References.ReferenceEnumerable.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.

Implements SiliconStudio.Quantum.References.IReference.

Definition at line 94 of file ReferenceEnumerable.cs.

Property Documentation

int SiliconStudio.Quantum.References.ReferenceEnumerable.Count
get

Definition at line 53 of file ReferenceEnumerable.cs.

object SiliconStudio.Quantum.References.ReferenceEnumerable.Index
getset

Definition at line 45 of file ReferenceEnumerable.cs.

bool SiliconStudio.Quantum.References.ReferenceEnumerable.IsDictionary
get

Gets whether this reference enumerates a dictionary collection.

Definition at line 50 of file ReferenceEnumerable.cs.

object SiliconStudio.Quantum.References.ReferenceEnumerable.ObjectValue
getset

Definition at line 39 of file ReferenceEnumerable.cs.

ObjectReference SiliconStudio.Quantum.References.ReferenceEnumerable.this[object index]
get

Definition at line 56 of file ReferenceEnumerable.cs.

Type SiliconStudio.Quantum.References.ReferenceEnumerable.Type
getset

Definition at line 42 of file ReferenceEnumerable.cs.


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