API reference
FilterBuilder Class
A filtering system for refining entity queries in the Spatial SDK.
The FilterBuilder class provides an API for constructing complex filter conditions that can be applied to Query results. Filters allow you to narrow down query results based on component attribute values, using various comparison operations and logical operators.
Filters are typically used in conjunction with the Query class to find entities that not only have specific components but also have specific values for those components' attributes.
Example - Basic filtering by attribute value:
// Find entities with TestComponent where intVar equals 1
val entities = Query.where { has(TestComponent.id) }
.filter { by(TestComponent.intVarData).isEqualTo(1) }
.eval()
Example - Combining multiple filters with logical operators:
// Find entities with TestComponent where intVar 0 AND floatVar < 0.5
val entities = Query.where { has(TestComponent.id) }
.filter { by(TestComponent.intVarData).greaterThan(0) and
by(TestComponent.floatVarData).lessThan(0.5f) }
.eval()
Example - Using the NOT operator:
// Find entities with TestComponent where intVar is NOT equal to 1
val entities = Query.where { has(TestComponent.id) }
.filter { not(by(TestComponent.intVarData).isEqualTo(1)) }
.eval()
Example - Filtering local entities:
// Find local entities with Controller component
val entities = Query.where { has(Controller.id) } .filter { isLocal() } .eval()
Signature
class FilterBuilder
Constructors
FilterBuilder
()
|
Signature
constructor() Returns FilterBuilder |
Methods
by
(
intData
)
|
Creates a new filter operation for an integer attribute.
This method is the entry point for filtering entities based on integer attribute values. It returns a ByIntFilterOperation object that provides methods for various comparison operations.
Signature
fun by(intData: IntAttributeData): ByIntFilterOperation Parameters intData: IntAttributeDataReturns ByIntFilterOperation |
by
(
longData
)
|
Creates a new filter operation for a long integer attribute.
This method is the entry point for filtering entities based on long integer attribute values. It returns a ByLongFilterOperation object that provides methods for various comparison operations.
Signature
fun by(longData: LongAttributeData): ByLongFilterOperation Parameters longData: LongAttributeDataReturns ByLongFilterOperation |
by
(
floatData
)
|
Creates a new filter operation for a float attribute.
This method is the entry point for filtering entities based on float attribute values. It returns a ByFloatFilterOperation object that provides methods for various comparison operations.
Signature
fun by(floatData: FloatAttributeData): ByFloatFilterOperation Parameters floatData: FloatAttributeDataReturns ByFloatFilterOperation |
by
(
boolData
)
|
Creates a new filter operation for a boolean attribute.
This method is the entry point for filtering entities based on boolean attribute values. It returns a ByBooleanFilterOperation object that provides methods for equality comparison.
Signature
fun by(boolData: BooleanAttributeData): ByBooleanFilterOperation Parameters boolData: BooleanAttributeDataReturns ByBooleanFilterOperation |
by
(
stringData
)
|
Creates a new filter operation for a string attribute.
This method is the entry point for filtering entities based on string attribute values. It returns a ByStringFilterOperation object that provides methods for various string comparison operations.
Signature
fun by(stringData: StringAttributeData): ByStringFilterOperation Parameters stringData: StringAttributeDataReturns ByStringFilterOperation |
by
(
enumData
)
|
Creates a new filter operation for an enum attribute.
This method is the entry point for filtering entities based on enum attribute values. It returns a ByEnumFilterOperation object that provides methods for equality comparison.
Signature
fun by(enumData: EnumAttributeData): ByEnumFilterOperation Parameters enumData: EnumAttributeDataReturns ByEnumFilterOperation |
by
(
uuidData
)
|
Creates a new filter operation for a UUID attribute.
This method is the entry point for filtering entities based on UUID attribute values. It returns a ByUUIDFilterOperation object that provides methods for equality comparison.
Signature
fun by(uuidData: UUIDAttributeData): ByUUIDFilterOperation Parameters uuidData: UUIDAttributeDataReturns ByUUIDFilterOperation |
by
(
vector2Data
)
|
Creates a new filter operation for a Vector2 attribute.
This method is the entry point for filtering entities based on Vector2 attribute values. It returns a ByVector2FilterOperation object that provides methods for comparing the entire vector or its individual components (x, y).
Signature
fun by(vector2Data: Vector2AttributeData): ByVector2FilterOperation Parameters vector2Data: Vector2AttributeDataReturns ByVector2FilterOperation |
by
(
vector3Data
)
|
Creates a new filter operation for a Vector3 attribute.
This method is the entry point for filtering entities based on Vector3 attribute values. It returns a ByVector3FilterOperation object that provides methods for comparing the entire vector or its individual components (x, y, z).
Signature
fun by(vector3Data: Vector3AttributeData): ByVector3FilterOperation Parameters vector3Data: Vector3AttributeDataReturns ByVector3FilterOperation |
by
(
vector4Data
)
|
Creates a new filter operation for a Vector4 attribute.
This method is the entry point for filtering entities based on Vector4 attribute values. It returns a ByVector4FilterOperation object that provides methods for comparing the entire vector or its individual components (x, y, z, w).
Signature
fun by(vector4Data: Vector4AttributeData): ByVector4FilterOperation Parameters vector4Data: Vector4AttributeDataReturns ByVector4FilterOperation |
by
(
poseData
)
|
Creates a new filter operation for a Pose attribute.
This method is the entry point for filtering entities based on Pose attribute values. It returns a ByPoseFilterOperation object that provides methods for comparing the entire pose or its individual components (position x/y/z, orientation w/x/y/z).
Signature
fun by(poseData: PoseAttributeData): ByPoseFilterOperation Parameters poseData: PoseAttributeDataReturns ByPoseFilterOperation |
by
(
mapData
)
|
Creates a new filter operation for a Map attribute.
This method is the entry point for filtering entities based on Map attribute values. It returns a ByMapFilterOperation object that provides methods for checking map properties.
Signature
fun <KeyType, ValueType> by(mapData: ExperimentalMapAttributeData<KeyType, ValueType>): ByMapFilterOperation<KeyType, ValueType> Parameters mapData: ExperimentalMapAttributeDataReturns ByMapFilterOperation |
by
(
entityData
)
|
Creates a new filter operation for an Entity attribute.
This method is the entry point for filtering entities based on Entity attribute values. It returns a ByEntityFilterOperation object that provides methods for equality comparison.
Signature
fun by(entityData: EntityAttributeData): ByEntityFilterOperation Parameters entityData: EntityAttributeDataReturns ByEntityFilterOperation |
by
(
timeData
)
|
Creates a new filter operation for a Time attribute.
This method is the entry point for filtering entities based on Time attribute values. It returns a ByTimeFilterOperation object that provides methods for various comparison operations.
Signature
fun by(timeData: TimeAttributeData): ByTimeFilterOperation Parameters timeData: TimeAttributeDataReturns ByTimeFilterOperation |
getFloatArray
()
|
Returns the float filter values as an array, or null if none were added.
Signature
fun getFloatArray(): FloatArray? Returns FloatArray? |
getIntArray
()
|
Returns the int filter values as an array, or null if none were added.
Signature
fun getIntArray(): IntArray? Returns IntArray? |
getLongArray
()
|
Returns the long filter values as an array, or null if none were added.
Signature
fun getLongArray(): LongArray? Returns LongArray? |
getStringArray
()
|
Returns the string filter values as an array, or null if none were added.
Signature
fun getStringArray(): Array<String>? Returns Array? |
isLocal
()
|
Creates a filter that matches only entities that are local to the client.
This is particularly useful in networked applications to filter for entities that belong to the local user.
Signature
fun isLocal(): IsLocalFilterNode |
not
(
filterNode
)
|
Creates a filter that negates another filter condition.
This method applies a logical NOT operation to the provided filter node, returning entities that do NOT match the specified condition.
Signature
fun not(filterNode: FilterNode): FilterNode Parameters |
Virtual reality / Meta Horizon
Support and legal
Virtual reality / Meta Horizon
Support and legal
Virtual reality / Meta Horizon
Support and legal
English (US)
© 2026 Meta