A class representing a filter operation for Vector3 attributes. It is used to build a filter expression by specifying comparison operations on Vector3 attribute values.

This class provides methods for creating filter nodes that represent various comparison operations on Vector3 attributes. It supports both:

Comparing entire Vector3 values (all X, Y, and Z components together)

Component-wise comparisons (filtering on just the X, Y, or Z component)

The component-wise filtering is enabled through the byX(), byY(), and byZ() methods, which configure the filter to operate on a specific component of the Vector3.

Example:

// Find entities where vector3Var equals Vector3(1.0f, 2.0f, 3.0f)
Query.where { has(TestComponent.id) }
     .filter { by(TestComponent.vector3VarData).isEqualTo(Vector3(1.0f, 2.0f, 3.0f)) }
// Find entities where vector3Var.x is greater than 0.5f
Query.where { has(TestComponent.id) }
     .filter { by(TestComponent.vector3VarData).byX().greaterThan(0.5f) }
// Find entities where vector3Var.z is between 0.0f and 1.0f
Query.where { has(TestComponent.id) }
     .filter { by(TestComponent.vector3VarData).byZ().greaterThanOrEqualTo(0.0f) and
             by(TestComponent.vector3VarData).byZ().lessThanOrEqualTo(1.0f) }

Signature

class ByVector3FilterOperation(val attrId: Int, var propId: Int = 0, val filterBuilder: FilterBuilder)

Constructors

ByVector3FilterOperation ( attrId , propId , filterBuilder ) : ByVector3FilterOperation

Signature

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

Parameters

The attribute id of the attributes or the filter operation.

The property id of the filter operation (0 for x, 1 for y, 2 for z).

                
                                    filterBuilder:
                                    
        FilterBuilder

The filter builder object used to create the filter node.

Returns

ByVector3FilterOperation

Properties

attrId : Int `[Get]`	Signature val attrId: Int
filterBuilder : FilterBuilder `[Get]`	Signature val filterBuilder: FilterBuilder
propId : Int `[Get][Set]`	Signature var propId: Int

Functions

byX () : ByVector3FilterOperation	Sets the filter to operate on the X component of the Vector3. Signature fun byX(): ByVector3FilterOperation Returns ByVector3FilterOperation This filter operation configured to filter on the X component.
byY () : ByVector3FilterOperation	Sets the filter to operate on the Y component of the Vector3. Signature fun byY(): ByVector3FilterOperation Returns ByVector3FilterOperation This filter operation configured to filter on the Y component.
byZ () : ByVector3FilterOperation	Sets the filter to operate on the Z component of the Vector3. Signature fun byZ(): ByVector3FilterOperation Returns ByVector3FilterOperation This filter operation configured to filter on the Z component.
greaterThan ( value ) : ByVector3FilterNode	Creates a filter node representing a greater than condition with the given float value. This compares only the component specified by propId (X, Y, or Z). By default, the filter operates on the X component. Signature fun greaterThan(value: Float): ByVector3FilterNode Parameters value: Float The float value to compare against. Returns ByVector3FilterNode A filter node representing the greater than condition.
greaterThanOrEqualTo ( value ) : ByVector3FilterNode	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, or Z). By default, the filter operates on the X component. Signature fun greaterThanOrEqualTo(value: Float): ByVector3FilterNode Parameters value: Float The float value to compare against. Returns ByVector3FilterNode A filter node representing the greater than or equal to condition.
isEqualTo ( value ) : ByVector3FilterNode	Creates a filter node representing an equality condition with the given Vector3 value. This compares all x, y, and z components of the vector. Signature fun isEqualTo(value: Vector3): ByVector3FilterNode Parameters value: Vector3 The Vector3 value to compare against. Returns ByVector3FilterNode A filter node representing the equality condition.
isEqualTo ( value ) : ByVector3FilterNode	Creates a filter node representing an equality condition with the given float value. This compares only the component specified by propId (X, Y, or Z). By default, the filter operates on the X component. Signature fun isEqualTo(value: Float): ByVector3FilterNode Parameters value: Float The float value to compare against. Returns ByVector3FilterNode A filter node representing the equality condition.
lessThan ( value ) : ByVector3FilterNode	Creates a filter node representing a less than condition with the given float value. This compares only the component specified by propId (X, Y, or Z). By default, the filter operates on the X component. Signature fun lessThan(value: Float): ByVector3FilterNode Parameters value: Float The float value to compare against. Returns ByVector3FilterNode A filter node representing the less than condition.
lessThanOrEqualTo ( value ) : ByVector3FilterNode	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, or Z). By default, the filter operates on the X component. Signature fun lessThanOrEqualTo(value: Float): ByVector3FilterNode Parameters value: Float The float value to compare against. Returns ByVector3FilterNode A filter node representing the less than or equal to condition.