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

OVRStorable Struct

Extends IEquatable< OVRStorable >

Static Fields

Null : readonly OVRStorable
A null representation of an OVRStorable.
Use this to compare with another component to determine whether it is null.
Signature
readonly OVRStorable OVRStorable.Null

Properties

Handle : ulong IOVRAnchorComponent< OVRStorable >.
[Get]
Signature
ulong IOVRAnchorComponent<OVRStorable>. OVRStorable.Handle
IsEnabled : bool
[Get]
True if this component is enabled and no change to its enabled status is pending.
Signature
bool OVRStorable.IsEnabled
IsNull : bool
[Get]
Whether this object represents a valid anchor component.
Signature
bool OVRStorable.IsNull
Type : SpaceComponentType IOVRAnchorComponent< OVRStorable >.
[Get]
Signature
SpaceComponentType IOVRAnchorComponent<OVRStorable>. OVRStorable.Type

Methods

Equals ( other )
Compares this component for equality with other .
Signature
bool OVRStorable.Equals(OVRStorable other)
Parameters
other: OVRStorable  The other component to compare with.
Returns
bool  True if both components belong to the same OVRAnchor, otherwise false.
Equals ( obj )
Compares this component for equality with obj .
Signature
override bool OVRStorable.Equals(object obj)
Parameters
obj: object  The object to compare with.
Returns
override bool  True if obj is an OVRStorable and Equals(OVRStorable) is true, otherwise false.
FromAnchor ( anchor )
Signature
OVRStorable IOVRAnchorComponent< OVRStorable >. OVRStorable.FromAnchor(OVRAnchor anchor)
Parameters
anchor: OVRAnchor
GetHashCode ()
Gets a hashcode suitable for use in a Dictionary or HashSet.
Signature
override int OVRStorable.GetHashCode()
Returns
override int  A hashcode for this component.
SetEnabledAsync ( enabled , timeout )
Sets the enabled status of this component.
A component must be enabled in order to access its data or do enable its functionality.
This method is asynchronous. Use the returned task to track the completion of this operation. The task's value indicates whether the operation was successful.
If the current enabled state matches enabled , then the returned task completes immediately with a True result. If there is already a pending change to the enabled state, the new request is queued.
Signature
OVRTask< bool > OVRStorable.SetEnabledAsync(bool enabled, double timeout=0)
Parameters
enabled: bool  The desired state of the component.
timeout: double  The timeout, in seconds, for the operation. Use zero to indicate an infinite timeout.
Returns
OVRTask< bool >  Returns an OVRTask<T> whose result indicates the result of the operation.
SetEnabledSafeAsync ( enabled , timeout )
(Obsolete) Sets the enabled status of this component if it differs from the current enabled state.
This method is obsolete. Use SetEnabledAsync instead.
Signature
OVRTask< bool > OVRStorable.SetEnabledSafeAsync(bool enabled, double timeout=0)
Parameters
enabled: bool  The desired state of the component.
timeout: double  The timeout, in seconds, for the operation. Use zero to indicate an infinite timeout.
Returns
OVRTask< bool >  Returns an OVRTask<T> whose result indicates the result of the operation.
ToString ()
Gets a string representation of this component.
Signature
override string OVRStorable.ToString()
Returns
override string  A string representation of this component.

Static Methods

operator!= ( lhs , rhs )
Compares two components for inequality.
Signature
static bool OVRStorable.operator!=(OVRStorable lhs, OVRStorable rhs)
Parameters
lhs: OVRStorable  The component to compare with rhs .
rhs: OVRStorable  The component to compare with lhs .
Returns
bool  True if the components do not belong to the same OVRAnchor, otherwise false.
operator== ( lhs , rhs )
Compares two components for equality.
Signature
static bool OVRStorable.operator==(OVRStorable lhs, OVRStorable rhs)
Parameters
lhs: OVRStorable  The component to compare with rhs .
rhs: OVRStorable  The component to compare with lhs .
Returns
bool  True if both components belong to the same OVRAnchor, otherwise false.