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

ByVector4FilterOperation

ByVector4FilterOperation

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

// Find entities where vector4Var.w is greater than 0.5f
Query.where { has(TestComponent.id) }
     .filter { by(TestComponent.vector4VarData).byW().greaterThan(0.5f) }

// Find entities where vector4Var.z is between 0.0f and 1.0f
Query.where { has(TestComponent.id)}
     .filter { by(TestComponent.vector4VarData).byZ().greaterThanOrEqualTo(0.0f) and
               by(TestComponent.vector4VarData).byZ().lessThanOrEqualTo(1.0f) }

Constructors

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

Properties

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

Functions

NameSummary
byW
fun byW(): ByVector4FilterOperation

Sets the filter to operate on the W component of the Vector4.
byX
fun byX(): ByVector4FilterOperation

Sets the filter to operate on the X component of the Vector4.
byY
fun byY(): ByVector4FilterOperation

Sets the filter to operate on the Y component of the Vector4.
byZ
fun byZ(): ByVector4FilterOperation

Sets the filter to operate on the Z component of the Vector4.
greaterThan
fun greaterThan(value: Float): ByVector4FilterNode

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

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, Y, Z, or W). By default, the filter operates on the X component.
isEqualTo
fun isEqualTo(value: Vector4): ByVector4FilterNode

Creates a filter node representing an equality condition with the given Vector4 value. This compares all x, y, z, and w components of the vector.



fun isEqualTo(value: Float): ByVector4FilterNode

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

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

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, Y, Z, or W). By default, the filter operates on the X component.
Did you find this page helpful?
Thumbs up icon
Thumbs down icon