Struct PickerOptions
A collection of settings that define how mesh element picking behaves.
Inherited Members
Namespace: UnityEngine.ProBuilder
Syntax
public struct PickerOptionsProperties
Default
Represents a set of picking options with default values. By default, the depthTest property is set to true and the rectSelectMode property is set to Partial.
Declaration
public static readonly PickerOptions Default { get; }Property Value
| Type | Description |
|---|---|
| PickerOptions |
depthTest
Gets or sets whether to perform depth testing when testing elements with raycasting.
Declaration
public bool depthTest { readonly get; set; }Property Value
| Type | Description |
|---|---|
| Boolean | True to select only visible elements; false to select all elements regardless of visibility. |
rectSelectMode
Gets or sets whether to require elements to be completely encompassed by the rect selection
(RectSelectMode.Complete) or to allow elements only partially inside the rect selection (RectSelectMode.Partial).
Declaration
public RectSelectMode rectSelectMode { readonly get; set; }Property Value
| Type | Description |
|---|---|
| RectSelectMode |
Remarks
Does not apply to vertex picking.
Methods
Equals(Object)
Evaluates whether the specified object is equivalent to this one.
Declaration
public override bool Equals(object obj)Parameters
| Type | Name | Description |
|---|---|---|
| Object | obj | The object to compare to this object. |
Returns
| Type | Description |
|---|---|
| Boolean | True if both objects are PickerOptions and their property values match; false otherwise. |
Overrides
Equals(PickerOptions)
Evaluates whether the specified PickerOptions object contains the same settings as this one has.
Declaration
public bool Equals(PickerOptions other)Parameters
| Type | Name | Description |
|---|---|---|
| PickerOptions | other | The PickerOptions object to compare to this object. |
Returns
| Type | Description |
|---|---|
| Boolean | True if the depthTest and rectSelectMode property values match; false otherwise. |
GetHashCode()
Returns the hash code for this object.
Declaration
public override int GetHashCode()Returns
| Type | Description |
|---|---|
| Int32 | A hash code for the current object. |
Overrides
Operators
Equality(PickerOptions, PickerOptions)
Returns true if the two PickerOptions objects have matching values.
Declaration
public static bool operator ==(PickerOptions a, PickerOptions b)Parameters
| Type | Name | Description |
|---|---|---|
| PickerOptions | a | The first object to compare. |
| PickerOptions | b | The second object to compare. |
Returns
| Type | Description |
|---|---|
| Boolean | True if the objects have matching values; false otherwise. |
Inequality(PickerOptions, PickerOptions)
Returns true if the values for the two PickerOptions objects don't match.
Declaration
public static bool operator !=(PickerOptions a, PickerOptions b)Parameters
| Type | Name | Description |
|---|---|---|
| PickerOptions | a | The first object to compare. |
| PickerOptions | b | The second object to compare. |
Returns
| Type | Description |
|---|---|
| Boolean | True if the values for the two PickerOptions objects don't match; false otherwise. |