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

OVRSharable Struct

Extends IEquatable< OVRSharable >

Static Fields

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

Properties

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

Methods

Equals ( other )
Compares this component for equality with other .
Signature
bool OVRSharable.Equals(OVRSharable other)
Parameters
other: OVRSharable  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 OVRSharable.Equals(object obj)
Parameters
obj: object  The object to compare with.
Returns
override bool  True if obj is an OVRSharable and Equals(OVRSharable) is true, otherwise false.
FromAnchor ( anchor )
Signature
OVRSharable IOVRAnchorComponent< OVRSharable >. OVRSharable.FromAnchor(OVRAnchor anchor)
Parameters
anchor: OVRAnchor
GetHashCode ()
Gets a hashcode suitable for use in a Dictionary or HashSet.
Signature
override int OVRSharable.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 > OVRSharable.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 > OVRSharable.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 OVRSharable.ToString()
Returns
override string  A string representation of this component.

Static Methods

operator!= ( lhs , rhs )
Compares two components for inequality.
Signature
static bool OVRSharable.operator!=(OVRSharable lhs, OVRSharable rhs)
Parameters
lhs: OVRSharable  The component to compare with rhs .
rhs: OVRSharable  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 OVRSharable.operator==(OVRSharable lhs, OVRSharable rhs)
Parameters
lhs: OVRSharable  The component to compare with rhs .
rhs: OVRSharable  The component to compare with lhs .
Returns
bool  True if both components belong to the same OVRAnchor, otherwise false.