Override volume and focus proxy API

Override volume and focus proxy API

HIBIKI entertainment's override volume and focus proxy components expose public APIs for runtime inspection, configuration, and custom workflows. The extension interface lets you inject custom focus and lens modifications into the solver pipeline.

AutoDepthOfFieldOverrideVolume

AutoDepthOfFieldOverrideVolume is a MonoBehaviour that represents a spatial or behavioural override region in the scene. It registers with the resolver and contributes focus, lens, and filtering overrides based on its role and priority.

Volume roles enum

Public properties

Public fields

Public methods

AutoDepthOfFieldFocusProxy

AutoDepthOfFieldFocusProxy is a sealed MonoBehaviour that requires a BoxCollider. It fits that collider around child renderers so PBADOF raycasts can hit objects that contain renderers but no suitable physics collider.

Public properties

Public methods

Usage example

The following example fits a weapon proxy to its visual hierarchy and then reads the resulting collider bounds.

using UnityEngine;
using HIBIKIentertainment.DepthOfField;

public class WeaponFocusProxySetup : MonoBehaviour
{
    [SerializeField] private Transform weaponVisualRoot;

    private void Start()
    {
        var proxy = GetComponent<AutoDepthOfFieldFocusProxy>();
        proxy.VisualRoot = weaponVisualRoot;
        proxy.Padding = new Vector3(0.05f, 0.05f, 0.05f);

        if (proxy.FitToVisuals())
        {
            Bounds bounds = proxy.ProxyCollider.bounds;
            Debug.Log($"Focus proxy fitted to {bounds.size}.");
        }
    }
}

AutoDepthOfFieldFocusTarget

AutoDepthOfFieldFocusTarget is a sealed MonoBehaviour that identifies a semantic autofocus subject. In Smart Subject mode, colliders on this GameObject and its children are grouped as one stable subject rather than treated as individual hits.

Add it from the component menu: HIBIKI Entertainment / Depth Of Field / Auto Depth Of Field Focus Target. The component enforces [DisallowMultipleComponent].

Public properties

Usage example

The following example adds a focus target to a character and biases the solver towards it.

using UnityEngine;
using HIBIKIentertainment.DepthOfField;

// Add AutoDepthOfFieldFocusTarget to a character at runtime
var target = myCharacter.AddComponent<AutoDepthOfFieldFocusTarget>();
target.FocusPoint = myCharacter.transform; // Use the character root as the focus point
target.Priority = 2.0f; // Score this subject twice as strongly

// Bias the solver towards this character
if (AutoDepthOfField.TryGetCurrent(out var dof))
{
    dof.SetFocusHint(target, strength: 4f);
}

Extension interface

The IAutoDepthOfFieldExtension interface lets you inject custom focus and lens modifications into the solver pipeline.

Interface

public interface IAutoDepthOfFieldExtension
{
    void Execute(AutoDepthOfField dof);
}

Implement Execute to run extension logic against the active AutoDepthOfField component.

ExtensionBaseData properties

Built-in extension: ExtendFocusDistanceExtension

ExtendFocusDistanceExtension implements IAutoDepthOfFieldExtension and applies ExtendedFocusDistance when that parameter's overrideState is enabled. It exposes a public ExtensionSettings field of type ExtensionBaseData.

CinemachineData

CinemachineData is a lightweight data container used by the Cinemachine 3 adapter. It exposes the following properties:

Usage example: custom extension

The following extension stores its own settings and checks the ExtendedFocusDistance override state during execution.

using UnityEngine;
using HIBIKIentertainment.DepthOfField;

public class WeaponZoomExtension : MonoBehaviour, IAutoDepthOfFieldExtension
{
    public ExtensionBaseData settings = new ExtensionBaseData();

    public void Execute(AutoDepthOfField dof)
    {
        // Apply extended focus distance when zoomed.
        if (settings.ExtendedFocusDistance.overrideState)
        {
            // The solver reads ExtendedFocusDistance from this extension.
        }
    }
}

Next steps

See the AutoDepthOfField component for the main component API, or the AutoDepthOfFieldAPI static API for the static compatibility facade.