Scene Search Filter

SceneSearchFilters define which areas of your scene ProStream will process. They improve performance by limiting the scope to specific hierarchies.

Purpose

SceneSearchFilters define which areas of your scene ProStream will process. They improve performance by limiting the scope to specific hierarchies.

Important

All GameObjects must be Prefabs to be compatible with ProStream systems. The Prefab system is used to differentiate one GameObject hierarchy from another. Non-Prefab GameObjects are skipped by the matching systems.

How to Add Scene Search Filters

Method 1: ProStream Editor (Recommended)

1. Open ProStream Editor: Tools | instance.id | ProStream | ProStream Editor
2. Click the Add Search Filters button
3. A hierarchy selector window will open showing root-level GameObjects
4. Select one or more root GameObjects that contain your prefabs
5. Click Confirm

What happens automatically:

• ProStream adds SceneSearchFilter component to selected GameObjects
• Locates all prefab instances under those GameObjects
• Adds MatchTracker components to each prefab child
• Sets tracker status to "Searchable"

Method 2: Context Menu (Alternative)

1. Right-click on one or many top-level GameObjects in the scene hierarchy
2. Select ProStream | Add Scene Search Filter

This will add a SceneSearchFilter component to the GameObject and begin indexing the child prefab GameObjects.

How Search Filters Work

Hierarchy Structure:

Scene
├── Buildings (SearchFilter)
│   ├── Building_01 (Prefab → MatchTracker added)
│   ├── Building_02 (Prefab → MatchTracker added)
│   └── Building_03 (Prefab → MatchTracker added)
├── Props (SearchFilter)
│   ├── Prop_01 (Prefab → MatchTracker added)
│   └── Prop_02 (Prefab → MatchTracker added)
└── Camera (No filter → ignored)

Key Points:

• Only prefab instances under search filter GameObjects are tracked
• This allows organizing large scenes into manageable sections
• Improves performance by limiting the scope of object tracking
• You can have multiple search filters in a scene

MatchTracker Component

When you add a search filter, ProStream automatically adds MatchTracker components to all prefab children:

MatchTracker Properties:

• FilterId - References parent SceneSearchFilter
• MatchStatus - Searchable, NotSearchable, or Converted
• IsEnabled - Whether tracker is active
• IsMatched - Whether a rule matched this object
• SectionId - Which streaming layer this object belongs to

You don't need to add MatchTracker manually - it's automatic.

Best Practices

Organize by Type

Create separate search filters for different object types:

Scene
├── Buildings (SearchFilter)
├── Vegetation (SearchFilter)
├── Props (SearchFilter)
├── Terrain (SearchFilter)
└── Lighting (No filter)

Use Descriptive Names

Name your filter GameObjects clearly:

• "Buildings_Residential"
• "Vegetation_Trees"
• "Props_Interactive"
• "Terrain_Ground"

Limit Scope

Don't add search filters to:

• Camera GameObjects
• Lighting systems
• UI elements
• Audio sources
• Manager objects

Performance Considerations

Smaller Scope = Better Performance

• Fewer objects to scan during rule matching
• Faster position calculation
• Reduced memory usage during processing

Multiple Filters

You can have as many search filters as needed:

• Each filter processes independently
• Allows parallel processing in future updates
• Easier to debug specific sections

Common Issues

No objects found during Calculate Positions

• Verify search filters are added
• Check that objects under filters are prefabs
• Ensure MatchTracker components were added

Too many objects matched

• Narrow search filter scope
• Split large filters into smaller ones
• Check for unintended prefab instances

Objects not being processed

• Verify object is under a search filter
• Check that object is a prefab instance
• Ensure MatchTracker status is "Searchable"

See Also

• Importance of Prefabs - Why prefabs are required
• Rule Engine - How objects are matched
• Standard Workflow - Complete setup guide