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

OVRStorable Struct

OVRStorable extends IOVRAnchorComponent< OVRStorable >.
OVRStorable extends IEquatable< OVRStorable >.

Overview

Properties

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

Static Fields

static readonly OVRStorable
Null[Get]
A null representation of an OVRStorable.

Public Member Functions

FromAnchor
( OVRAnchor anchor )
OVRTask< bool >
SetEnabledAsync
( bool enabled,
double timeout )
Sets the enabled status of this component.
OVRTask< bool >
SetEnabledSafeAsync
( bool enabled,
double timeout )
(Obsolete) Sets the enabled status of this component if it differs from the current enabled state.
bool
Equals
( OVRStorable other )
Compares this component for equality with other .
override bool
Equals
( object obj )
Compares this component for equality with obj .
override int
Gets a hashcode suitable for use in a Dictionary or HashSet.
override string
Gets a string representation of this component.

Static Public Member Functions

static bool
Compares two components for equality.
static bool
Compares two components for inequality.

Details

Properties

SpaceComponentType IOVRAnchorComponent<OVRStorable>. OVRStorable.Type
No description available.
ulong IOVRAnchorComponent<OVRStorable>. OVRStorable.Handle
No description available.
bool OVRStorable.IsNull
Whether this object represents a valid anchor component.
bool OVRStorable.IsEnabled
True if this component is enabled and no change to its enabled status is pending.
SpaceComponentType OVRStorable.Type
No description available.
ulong OVRStorable.Handle
No description available.

Public Statics

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

Member Functions

OVRStorable IOVRAnchorComponent< OVRStorable >. OVRStorable.FromAnchor
( OVRAnchor anchor )
No description available.
OVRTask< bool > OVRStorable.SetEnabledAsync
( bool enabled,
double 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.
Parameters
enabled
The desired state of the component.
timeout
The timeout, in seconds, for the operation. Use zero to indicate an infinite timeout.
Returns
Returns an OVRTask<T> whose result indicates the result of the operation.
OVRTask< bool > OVRStorable.SetEnabledSafeAsync
( bool enabled,
double timeout )
(Obsolete) Sets the enabled status of this component if it differs from the current enabled state.
This method is obsolete. Use SetEnabledAsync instead.
Parameters
enabled
The desired state of the component.
timeout
The timeout, in seconds, for the operation. Use zero to indicate an infinite timeout.
Returns
Returns an OVRTask<T> whose result indicates the result of the operation.
bool OVRStorable.Equals
( OVRStorable other )
Compares this component for equality with other .
Parameters
other
The other component to compare with.
Returns
True if both components belong to the same OVRAnchor, otherwise false.
override bool OVRStorable.Equals
( object obj )
Compares this component for equality with obj .
Parameters
obj
The object to compare with.
Returns
True if obj is an OVRStorable and Equals(OVRStorable) is true, otherwise false.
override int OVRStorable.GetHashCode ( )
Gets a hashcode suitable for use in a Dictionary or HashSet.
Returns
A hashcode for this component.
override string OVRStorable.ToString ( )
Gets a string representation of this component.
Returns
A string representation of this component.

Static Member Functions

static bool OVRStorable.operator==
( OVRStorable lhs,
Compares two components for equality.
Parameters
lhs
The component to compare with rhs .
rhs
The component to compare with lhs .
Returns
True if both components belong to the same OVRAnchor, otherwise false.
static bool OVRStorable.operator!=
( OVRStorable lhs,
Compares two components for inequality.
Parameters
lhs
The component to compare with rhs .
rhs
The component to compare with lhs .
Returns
True if the components do not belong to the same OVRAnchor, otherwise false.
Did you find this page helpful?
Thumbs up icon
Thumbs down icon