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

ByVector2FilterOperation

ByVector2FilterOperation

class ByVector2FilterOperation(val attrId: Int, var propId: Int = 0, val filterBuilder: FilterBuilder)
A class representing a filter operation for Vector2 attributes. It is used to build a filter expression by specifying comparison operations on Vector2 attribute values.
This class provides methods for creating filter nodes that represent various comparison operations on Vector2 attributes. It supports both:
  • Comparing entire Vector2 values (both X and Y components together)
  • Component-wise comparisons (filtering on just the X or Y component)
The component-wise filtering is enabled through the byX() and byY() methods, which configure the filter to operate on a specific component of the Vector2.
Example:
// Find entities where vector2Var equals Vector2(1.0f, 2.0f)
Query.where { has(TestComponent.id) }
     .filter { by(TestComponent.vector2VarData).isEqualTo(Vector2(1.0f, 2.0f)) }

// Find entities where vector2Var.x is greater than 0.5f
Query.where { has(TestComponent.id) }
     .filter { by(TestComponent.vector2VarData).byX().greaterThan(0.5f) }

// Find entities where vector2Var.y is between 0.0f and 1.0f
Query.where { has(TestComponent.id)}
     .filter { by(TestComponent.vector2VarData).byY().greaterThanOrEqualTo(0.0f) and
               by(TestComponent.vector2VarData).byY().lessThanOrEqualTo(1.0f) }

Constructors

NameSummary
ByVector2FilterOperation
constructor(attrId: Int, propId: Int = 0, filterBuilder: FilterBuilder)

Properties

NameSummary
attrId
val attrId: Int
filterBuilder
val filterBuilder: FilterBuilder
propId
var propId: Int

Functions

NameSummary
byX
fun byX(): ByVector2FilterOperation

Sets the filter to operate on the X component of the Vector2.
byY
fun byY(): ByVector2FilterOperation

Sets the filter to operate on the Y component of the Vector2.
greaterThan
fun greaterThan(value: Float): ByVector2FilterNode

Creates a filter node representing a greater than condition with the given float value. This compares only the component specified by propId (X or Y). By default, the filter operates on the X component.
greaterThanOrEqualTo
fun greaterThanOrEqualTo(value: Float): ByVector2FilterNode

Creates a filter node representing a greater than or equal to condition with the given float value. This compares only the component specified by propId (X or Y). By default, the filter operates on the X component.
isEqualTo
fun isEqualTo(value: Vector2): ByVector2FilterNode

Creates a filter node representing an equality condition with the given Vector2 value. This compares both x and y components of the vector.



fun isEqualTo(value: Float): ByVector2FilterNode

Creates a filter node representing an equality condition with the given float value. This compares only the component specified by propId (X or Y). By default, the filter operates on the X component.
lessThan
fun lessThan(value: Float): ByVector2FilterNode

Creates a filter node representing a less than condition with the given float value. This compares only the component specified by propId (X or Y). By default, the filter operates on the X component.
lessThanOrEqualTo
fun lessThanOrEqualTo(value: Float): ByVector2FilterNode

Creates a filter node representing a less than or equal to condition with the given float value. This compares only the component specified by propId (X or Y). By default, the filter operates on the X component.
Did you find this page helpful?
Thumbs up icon
Thumbs down icon
Nav Logo
Virtual reality / Meta Horizon
Virtual reality / Meta Horizon
Virtual reality / Meta Horizon
English (US)
© 2025 Meta