Skip to content

Added /// comments to VectorFilterOptions. #1049

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Oct 3, 2018
Merged

Added /// comments to VectorFilterOptions. #1049

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
68 changes: 68 additions & 0 deletions sdkproject/Assets/Mapbox/Unity/LayerProperties/VectorFilterOptions.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -53,6 +53,12 @@ private void AddFilterToList(LayerFilter layerFilter)
HasChanged = true;
}

/// <summary>
/// Adds a string filter that uses a contains operator.
/// </summary>
/// <returns>The filter.</returns>
/// <param name="key">Key.</param>
/// <param name="property">Property.</param>
public virtual ILayerFilter AddStringFilterContains(string key, string property)
{
LayerFilter layerFilter = new LayerFilter()
Expand All @@ -66,6 +72,12 @@ public virtual ILayerFilter AddStringFilterContains(string key, string property)

}

/// <summary>
/// Adds a number filter that uses an equals operator.
/// </summary>
/// <returns>The filter.</returns>
/// <param name="key">Key.</param>
/// <param name="value">Value.</param>
public virtual ILayerFilter AddNumericFilterEquals(string key, float value)
{
LayerFilter layerFilter = new LayerFilter()
Expand All @@ -78,6 +90,12 @@ public virtual ILayerFilter AddNumericFilterEquals(string key, float value)
return layerFilter;
}

/// <summary>
/// Adds a number filter that uses a less than operator.
/// </summary>
/// <returns>The filter.</returns>
/// <param name="key">Key.</param>
/// <param name="value">Value.</param>
public virtual ILayerFilter AddNumericFilterLessThan(string key, float value)
{
LayerFilter layerFilter = new LayerFilter()
Expand All @@ -90,6 +108,12 @@ public virtual ILayerFilter AddNumericFilterLessThan(string key, float value)
return layerFilter;
}

/// <summary>
/// Adds a number filter that uses a greater than operator.
/// </summary>
/// <returns>The filter.</returns>
/// <param name="key">Key.</param>
/// <param name="value">Value.</param>
public virtual ILayerFilter AddNumericFilterGreaterThan(string key, float value)
{
LayerFilter layerFilter = new LayerFilter()
Expand All @@ -102,6 +126,13 @@ public virtual ILayerFilter AddNumericFilterGreaterThan(string key, float value)
return layerFilter;
}

/// <summary>
/// Adds a number filter that uses an in range operator.
/// </summary>
/// <returns>The filter.</returns>
/// <param name="key">Key.</param>
/// <param name="min">Minimum.</param>
/// <param name="max">Max.</param>
public virtual ILayerFilter AddNumericFilterInRange(string key, float min, float max)
{
LayerFilter layerFilter = new LayerFilter()
Expand All @@ -120,6 +151,9 @@ public void AddFilter()
AddFilterToList(new LayerFilter());
}

/// <summary>
/// Removes all filters.
/// </summary>
public virtual void RemoveAllFilters()
{
for (int i = 0; i < filters.Count; i++)
Expand All @@ -132,6 +166,10 @@ public virtual void RemoveAllFilters()
}
}

/// <summary>
/// Removes a filter.
/// </summary>
/// <param name="layerFilter">Layer filter.</param>
public virtual void RemoveFilter(LayerFilter layerFilter)
{
layerFilter.PropertyHasChanged -= OnLayerFilterChanged;
Expand All @@ -142,11 +180,19 @@ public virtual void RemoveFilter(LayerFilter layerFilter)
}
}

/// <summary>
/// Removes a filter.
/// </summary>
/// <param name="filter">Filter.</param>
public virtual void RemoveFilter(ILayerFilter filter)
{
RemoveFilter((LayerFilter)filter);
}

/// <summary>
/// Removes the filter using an index lookup.
/// </summary>
/// <param name="index">Index.</param>
public virtual void RemoveFilter(int index)
{
if (index < filters.Count && filters[index] != null)
Expand All @@ -155,6 +201,11 @@ public virtual void RemoveFilter(int index)
}
}

/// <summary>
/// Gets a filter using an index lookup.
/// </summary>
/// <returns>The filter.</returns>
/// <param name="index">Index.</param>
public virtual ILayerFilter GetFilter(int index)
{
if (index < filters.Count && filters[index] != null)
Expand All @@ -164,11 +215,20 @@ public virtual ILayerFilter GetFilter(int index)
return null;
}

/// <summary>
/// Gets all filters.
/// </summary>
/// <returns>All filters.</returns>
public virtual IEnumerable<ILayerFilter> GetAllFilters()
{
return (IEnumerable<ILayerFilter>)filters.AsEnumerable();
}

/// <summary>
/// Gets the filters by query.
/// </summary>
/// <returns>Filters by query.</returns>
/// <param name="query">Query.</param>
public virtual IEnumerable<ILayerFilter> GetFiltersByQuery(Func<ILayerFilter, bool> query)
{
foreach (var filter in filters)
Expand All @@ -180,11 +240,19 @@ public virtual IEnumerable<ILayerFilter> GetFiltersByQuery(Func<ILayerFilter, bo
}
}

/// <summary>
/// Gets the type of the filter combiner.
/// </summary>
/// <returns>The filter combiner type.</returns>
public virtual LayerFilterCombinerOperationType GetFilterCombinerType()
{
return combinerType;
}

/// <summary>
/// Sets the type of the filter combiner.
/// </summary>
/// <param name="layerFilterCombinerOperationType">Layer filter combiner operation type.</param>
public virtual void SetFilterCombinerType(LayerFilterCombinerOperationType layerFilterCombinerOperationType)
{
combinerType = layerFilterCombinerOperationType;
Expand Down