API reference
API reference
Select your platform
No SDKs available
No versions available

ClassToValueDecorator Class

Base class for Context-based decoration, specifically where the instance being decorated (InstanceT ) is a class type, but the data being used as a decoration (DecorationT ) is not.
Automatically removes decorations when the decorated instance is cleaned up.
As with the ClassToClassDecorator<InstanceT, DecorationT>, decorating instances using a ClassToValueDecorator is a non-invasive operation which will not alter the lifespan or other behavior of the decorated instance.

Constructors

ClassToValueDecorator ()
Signature
Oculus.Interaction.ClassToValueDecorator< InstanceT, DecorationT >.ClassToValueDecorator()

Methods

AddDecoration ( instance , decoration )
Associates an instance with a decoration.
If this instance was already decorated, the old decoration is removed. If there were any outstanding asynchronous requests for the decoration of this instance (from prior calls to GetDecorationAsync(InstanceT), those requests will be fulfilled as part of this operation.
Signature
void Oculus.Interaction.ClassToValueDecorator< InstanceT, DecorationT >.AddDecoration(InstanceT instance, DecorationT decoration)
Parameters
instance: InstanceT  The instance to be decorated
decoration: DecorationT  The decoration to be added to this instance
Returns
void
GetDecorationAsync ( instance )
Asynchronously retrieves the decoration associated with an instance.
If the instance already has a decoration, the returned task is immediately completed with the currently-available decoration. If no decoration is yet available for this instance, the returned task will only be completed during the call to AddDecoration(InstanceT, DecorationT) for the instance in question.
Signature
Task<DecorationT> Oculus.Interaction.ClassToValueDecorator< InstanceT, DecorationT >.GetDecorationAsync(InstanceT instance)
Parameters
instance: InstanceT  The instance for which to retrieve the decoration
Returns
Task< DecorationT >  A task resulting in the decoration associated with instance
RemoveDecoration ( instance )
Removes the association between an instance and a decoration.
If this instance had no decoration, this does nothing. If a decoration was removed, note that GetDecorationAsync(InstanceT) will resume returning uncompleted tasks for this instance, which will be completed if and when the instance is decorated again.
Signature
void Oculus.Interaction.ClassToValueDecorator< InstanceT, DecorationT >.RemoveDecoration(InstanceT instance)
Parameters
instance: InstanceT  The instance from which decoration should be removed
Returns
void
TryGetDecoration ( instance , decoration )
Synchronously retrieves the decoration associated with an instance, if one is available.
Signature
bool Oculus.Interaction.ClassToValueDecorator< InstanceT, DecorationT >.TryGetDecoration(InstanceT instance, out DecorationT decoration)
Parameters
instance: InstanceT  The instance for which to retrieve the decoration
decoration: out DecorationT  Out parameter to be populated with the decoration if one exists, otherwise null
Returns
bool  True if decoration was populated with a valid decoration, otherwise false