Options to toggle the portal features on and off.
This option set is equivalent to setting
``PortalComponent/clippingMode-swift.property`` and
``PortalComponent/crossingMode-swift.property`` directly.
Use this type with ``PortalComponent/init(target:plane:options:)``.
Members (4)
get · iOS 18.0+
clipContents
TypeScript
get clipContents(): PortalComponent_Options
Swift declaration
static let clipContents: PortalComponent.Options
An option that enables the clipping feature.
If this option is in the option set, the user-defined geometry for ``clippingMode``
clips the contents within the portal world.
get · iOS 18.0+
allowCrossing
TypeScript
get allowCrossing(): PortalComponent_Options
Swift declaration
static let allowCrossing: PortalComponent.Options
An option that enables the crossing feature.
Objects within the portal world with a ``PortalCrossingComponent`` can cross
the portal when the `allowCrossing` option is in an enabled state.
Crossing behavior is based on the user-defined geometry for ``crossingMode``.
init · iOS 18.0+
init
TypeScript
init(rawValue: number): PortalComponent_Options
Swift declaration
init(rawValue: UInt)
Creates a new option set from the given raw value.
This initializer always succeeds, even if the value passed as `rawValue`
exceeds the static properties declared as part of the option set. This
example creates an instance of `ShippingOptions` with a raw value beyond
the highest element, with a bit mask that effectively contains all the
declared static members.
let extraOptions = ShippingOptions(rawValue: 255)
print(extraOptions.isStrictSuperset(of: .all))
// Prints "true"
- Parameter rawValue: The raw value of the option set to create. Each bit
of `rawValue` potentially represents an element of the option set,
though raw values may include bits that are not defined as distinct
values of the `OptionSet` type.
get · iOS 18.0+
rawValue
TypeScript
getRawValue($self: PortalComponent_Options): number
Swift declaration
let rawValue: UInt
The corresponding value of the raw type.
A new instance initialized with `rawValue` will be equivalent to this
instance. For example:
enum PaperSize: String {
case A4, A5, Letter, Legal
}
let selectedSize = PaperSize.Letter
print(selectedSize.rawValue)
// Prints "Letter"
print(selectedSize == PaperSize(rawValue: selectedSize.rawValue)!)
// Prints "true"