Skip to content

Surface actor ​

The BP_FluxSurface actor is an abstract class generalizing an audiovisual representation of the simulation and coastline domain data. By default, this actor can’t be placed in the level, as it is only an abstract class designed as a template that should be configured.

An abstract actor is like a guide for creating new actors. It defines some common features that all related classes should have, but it’s not complete on its own. Other classes need to finish the details. For example, an abstract class may not specify any ambient water audio, but a customized ocean template has sounds that match the type of water it represents.

The surface actor implements a list of advanced subsystems:

Actor componentFeatures
DecalCausticsWetcaustics decal
surface wetness decal
SurfaceOverMeshsurface mesh
surface scattering
surface foam
surface detail advection
Post-Processunderwater post-process
underwater waterline
SurfaceUnderMeshunderwater surface
AudioComponentAnalyzing the fluid surface for the audio source
Volume Absorption, Volume ScatteringRendering underwater fog and absorption volume

The BP_FluxSurface is an abstract base parent class, meaning it can’t be placed directly on a level. Configuring all these subsystems can be time-consuming, particularly for new users. This is why the package includes basic, configured surface child actor templates, which can be found in the FluidFlux/Surface/Templates folder.

TemplateDescription
BP_FluxSurface_WaterThe default water surface is spawned dynamically within the domain.
SurfaceActorReference is not specified.
BP_FluxSurface_RiverSimple river/waterfall material and basic underwater post-process, river audio
BP_FluxSurface_OceanAdvanced ocean materials, ocean audio, materials blended with wave actor, underwater mesh, underwater scattering, and absorption volume.
BP_FluxSurface_CoastlineRendering two domains, simulation, and coastline at the same time.

Users can also implement their own surface templates and extend the surface’s functionalities.

The surface actor does not have any data to render, meaning that simulation or coastline domains must send it to the actor by setting the SurfaceActorReference. The SurfaceActorReference attribute in the Domain actor you use (SimulationDomain or CoastlineDomain) should reference the surface actor that will render the data. Otherwise, the domain will spawn a temporary water surface that can’t be configured by hand.

Subsystems ​

Each part of the surface actor is described on its own page: