ALCCClippingVolume: volumen de recorte del 3DGS

Actor de volumen de recorte que recorta parte de una escena LCC con un volumen de caja o de esfera.

#include "Tools/LCCClippingVolume.h"

Para los pasos de uso, una demostración y la descripción del panel de propiedades, consultar Edición de escenas - Volúmenes de recorte. Esta página solo enumera las interfaces.

Propiedades

Para el significado de los valores, consultar EClipType y EClipVolumeType.

Ninguna de las tres propiedades tiene Setter, y una asignación en tiempo de ejecución requiere una llamada a Refresh para surtir efecto. Lo mismo se aplica a un cambio del transform en tiempo de ejecución.

Métodos

SetUpdateComponent

UFUNCTION(BlueprintCallable, Category = "XGrids")
void SetUpdateComponent(ULCCComponentBase* Component);

Vincula el Component LCC que se debe actualizar.

Refresh() necesita esta vinculación para surtir efecto, ya que internamente marca el Component vinculado como necesitado de reconstruir su estado de renderizado. Sin vinculación, Refresh() no provoca ninguna actualización del renderizado.

Añadir un volumen con AddClippingVolume suele establecer ya la asociación; cuando un cambio en un volumen de recorte creado dinámicamente en tiempo de ejecución no surte efecto, comprobar primero si se llamó a este método.

Refresh

UFUNCTION(BlueprintCallable, Category = "XGrids")
void Refresh();

Provoca manualmente una actualización del resultado del recorte; internamente marca el Component LCC vinculado como necesitado de reconstruir su estado de renderizado.

Es necesaria una llamada después de cambiar un volumen de recorte en tiempo de ejecución para que el cambio surta efecto, lo que incluye:

• Cambios de propiedades: bEnabled, Mode, VolumeType. Estas propiedades no tienen Setter, y una asignación directa no notifica al lado del renderizado.
• Cambios del transform: SetActorLocation, SetActorRotation, SetActorScale3D.

Las actualizaciones automáticas solo se producen en el editor: los cambios de propiedades en el panel Details pasan por PostEditChangeProperty, y arrastrar el gizmo pasa por funciones como EditorApplyTranslation. Todas esas vías están bajo WITH_EDITOR y no existen en tiempo de ejecución.

Requiere que se haya llamado a SetUpdateComponent, o que la asociación se haya establecido mediante AddClippingVolume. No se provoca ninguna actualización del renderizado mientras no haya ningún Component vinculado.

Al cambiar varios volúmenes de recorte a la vez, llamar a Refresh() en cada uno después de cambiar sus propiedades.

Creación en tiempo de ejecución

#include "Tools/LCCClippingVolume.h"
#include "LCCComponentBase.h"

ALCCClippingVolume* AMyTool::CreateBoxClip(
    ULCCComponentBase* Component, const FVector& Location, const FVector& Extent)
{
    ALCCClippingVolume* Volume = GetWorld()->SpawnActor<ALCCClippingVolume>(
        ALCCClippingVolume::StaticClass(), Location, FRotator::ZeroRotator);
    if (!Volume)
    {
        return nullptr;
    }

    Volume->VolumeType = EClipVolumeType::Box;
    Volume->Mode = EClipType::Inside;
    Volume->bEnabled = true;

    // el tamaño de un AVolume se controla mediante el escalado
    Volume->SetActorScale3D(Extent / 100.0f);

    Volume->SetUpdateComponent(Component);
    Component->AddClippingVolume(Volume);

    return Volume;
}

Para alternar el efecto del recorte de forma temporal, no añadir ni eliminar elementos del array; cambiar bEnabled es más ligero. No olvidar llamar a Refresh() después del cambio:

for (ALCCClippingVolume* Volume : MyVolumes)
{
    if (Volume)
    {
        Volume->bEnabled = bEnable;
        Volume->Refresh();
    }
}

Mover un volumen de recorte en tiempo de ejecución para una animación también requiere una actualización cada vez:

// desplazar el volumen de recorte a lo largo de la escena
FVector Loc = ClipVolume->GetActorLocation();
Loc.X += 200.0f * DeltaTime;
ClipVolume->SetActorLocation(Loc);
ClipVolume->Refresh();          // los cambios del transform en tiempo de ejecución no se actualizan automáticamente

Para los nodos de Blueprint, consultar Edición de escenas - Métodos de Blueprint.

Notas

• El recorte solo afecta al renderizado, no a la colisión. Una zona recortada puede seguir siendo impactada por un rayo y sigue bloqueando a un personaje.
• Varios volúmenes de recorte que actúan a la vez se evalúan de forma independiente y sus efectos se acumulan. Mezclar Inside y Outside produce fácilmente resultados inesperados.
• El número de volúmenes de recorte activos a la vez está limitado, a 50 sin licencia; los excedentes no participan en el renderizado y se registra una advertencia. Los volúmenes de recorte y los planos de sección comparten esta cuota. Para las licencias, consultar Ediciones y licencias.
• Destruir un volumen de recorte solo provoca una actualización del renderizado y no elimina el elemento del array ClippingVolumes del Component, lo que deja un puntero obsoleto en el array (se omite automáticamente durante el renderizado). Para mantener el array limpio, llamar a RemoveClippingVolume antes de destruirlo.

Véase también

• Edición de escenas: descripción completa de uso
• ALCCSectionPlane: seccionado con un plano
• ULCCComponentBase: AddClippingVolume y RemoveClippingVolume