## Subset

### Description

Subset takes a collection of elements (objects or subcomponents) and determines the subset of elements that match the filter requirements. Softimage uses the Subset callback to filter the nodes displayed in an explorer view, and to filter subcomponents selected in a 3D view. If you don't provide a Subset callback, Softimage calls Match on each object to be filtered.

### Applies To

Custom Filters

### Syntax

    public class <filter_name>
    {
            public bool Subset( Context in_context )
            {
                    ...
            }
    }

    CStatus <filter_name>_Subset( CRef& in_context )
    {
            ...
    }

    function <filter_name>_Subset( in_context )
    {
            ...
    }

    def <filter_name>_Subset( in_context ):
            ...

    Function <filter_name>_Subset( in_context )
            ...
    End Function

    sub <filter_name>_Subset
    {
            my $in_context = shift;
    }

<filter_name> is the name specified in the call to PluginRegistrar.RegisterFilter, with any spaces converted to underscores.

### Parameters

Parameter | Language | Type | Description
--- | --- | --- | ---
in_context | Scripting and C# | Context | Context.Source returns the Filter.
| C++ | CRef& | A reference to the Context object. Context::GetSource returns the Filter.

### Context Attributes

Attribute | Description
--- | ---
Input | A collection of objects to filter.
Output | The subset of the input objects that match the filter requirements.

### See Also

- Init (Filter)
- IsApplicable
- Match
- Filter Callbacks