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

A class representing a reference to another object that has a different model. More...

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

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...
 
void SetTarget (IModelNode targetNode)
 Set the TargetNode and TargetGuid to the given object. 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...
 
bool Equals (IReference other)
 
override string ToString ()
 

Properties

IModelNode TargetNode The given type does not match the given object." [get, set]
 Gets the model node targeted by this reference, if available. More...
 
object ObjectValue [get]
 
Type Type [get, set]
 
object Index [get, set]
 
Guid TargetGuid [get, set]
 Gets the Guid of the model node targeted by this reference, if available. More...
 
- 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 a reference to another object that has a different model.

Definition at line 10 of file ObjectReference.cs.

Member Function Documentation

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

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

Implements SiliconStudio.Quantum.References.IReference.

Definition at line 51 of file ObjectReference.cs.

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

Definition at line 103 of file ObjectReference.cs.

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

Refresh this reference and its nested references.

Implements SiliconStudio.Quantum.References.IReference.

Definition at line 59 of file ObjectReference.cs.

void SiliconStudio.Quantum.References.ObjectReference.SetTarget ( IModelNode  targetNode)

Set the TargetNode and TargetGuid to the given object.

Parameters
targetNodeThe IModelNode this reference should point on.

Definition at line 69 of file ObjectReference.cs.

References SiliconStudio.Quantum.IModelNode.Content.

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

Definition at line 113 of file ObjectReference.cs.

bool SiliconStudio.Quantum.References.ObjectReference.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 82 of file ObjectReference.cs.

Property Documentation

object SiliconStudio.Quantum.References.ObjectReference.Index
getset

Definition at line 43 of file ObjectReference.cs.

object SiliconStudio.Quantum.References.ObjectReference.ObjectValue
get

Definition at line 37 of file ObjectReference.cs.

Guid SiliconStudio.Quantum.References.ObjectReference.TargetGuid
getset

Gets the Guid of the model node targeted by this reference, if available.

Definition at line 48 of file ObjectReference.cs.

IModelNode SiliconStudio.Quantum.References.ObjectReference.TargetNode The given type does not match the given object."
getset

Gets the model node targeted by this reference, if available.

Definition at line 34 of file ObjectReference.cs.

Type SiliconStudio.Quantum.References.ObjectReference.Type
getset

Definition at line 40 of file ObjectReference.cs.


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