Engine.FluidSurfaceComponent

Extends

PrimitiveComponent

Modifiers

native ( Fluid ) AutoExpandCategories ( FluidSurfaceComponent , Fluid , FluidDetail ) hidecategories ( Object ) dependson ( LightmassPrimitiveSettingsObject ) editinlinenew

Utility component for drawing an interactive body of fluid. Origin is at the component location.

Core.Object
|   
+-- Core.Component
   |   
   +-- Engine.ActorComponent
      |   
      +-- Engine.PrimitiveComponent
         |   
         +-- Engine.FluidSurfaceComponent

Functions Summary
		ApplyForce (vector WorldPos, float Strength, float Radius, optional bool bImpulse)
		SetDetailPosition (vector WorldPos)
		SetSimulationPosition (vector WorldPos)

ClampMap Source code

Stores a 1 for each clamped vertex that should not be simulated, and a 0 for each vertex that should be simulated.

DeactivationTimer Source code

DetailPosition Source code

EditorViewPosition Source code

FluidHeight Source code

FluidSimulation Source code

All transient member variables are contained inside the FFluidSurfaceInfo object.

FluidWidth Source code

LightMap Source code

Reference to the texture lightmap resource.

ShadowMaps Source code

SimulationPosition Source code

TestRippleAngle Source code

TestRippleTime Source code

ViewDistance Source code

Fluid

DeactivationDistance Source code

Distance between the camera and the closest fluid edge where the fluid will deactivate and start rendering as a simple flat quad.

EnableDetail Source code

Whether the detail simulation grid should be used or not

EnableSimulation Source code

Whether the vertex positions in the simulation grid should be animated or not

FluidDamping Source code

How much to dampen the amplitude of waves in the fluid (0.0-30.0)

FluidHeightScale Source code

Wave height scale - higher value produces higher waves

FluidTravelSpeed Source code

Wave travel speed factor for the simulation grid (0.0-1.0)

FluidUpdateRate Source code

Fluid update rate in number of updates per second

ForceContinuous Source code

How much ripple to make when an Actor moves through the fluid.

ForceImpact Source code

How much ripple to make when fluid is hit by a weapon or touched by a object for the first time.

GPUTessellationFactor Source code

How much the GPU should tessellate the fluid grid. (Only used on platforms that completely supports GPU tessellation.)

GridSpacing Source code

The size of a grid cell in the vertex simulation (in world space units)

GridSpacingLowRes Source code

Fluids automatically draw a low-resolution grid when they are deactivated. A reasonable value is needed for vertex fogging to work when the fluid is translucent. A maximum of 65000 vertices are allowed before GridSpacingLowRes is clamped.

LightingContrast Source code

Increasing this value adds more contrast to the lighting by exaggerating the curvature for the fluid normals.

SimulationQuadsX Source code

Number of quads in the simulated grid (along the X-axis)

SimulationQuadsY Source code

Number of quads in the simulated grid (along the Y-axis)

TargetDetail Source code

Target actor which the detail texture will center around. If none is provided, the detail texture will center around the active camera.

TargetSimulation Source code

Target actor which the simulation grid will center around. If none is provided, the simulation grid will center around the active camera.

FluidDebug

bPause Source code

Whether to update the fluid or pause it

bShowDetailNormals Source code

Whether to render an overlay of the detail normal for debugging

bShowDetailPosition Source code

Whether to visualize the placement of the detail texture

bShowFluidDetail Source code

Whether to show the detail normalmap on the fluid

bShowFluidSimulation Source code

Whether to visualize the height of the main fluid grid

bShowSimulationNormals Source code

Whether to render lines for normals

bShowSimulationPosition Source code

Whether to visualize the placement of the simulated grid

bTestRipple Source code

Whether to enable a force for debugging

bTestRippleCenterOnDetail Source code

Whether the test ripple should center on the detail texture or the main grid.

NormalLength Source code

The length of the visualized normals, when bShowSimulationNormals is turned on

TestRippleFrequency Source code

Number of seconds between each pling on the test ripple. 0 makes it continuous.

TestRippleRadius Source code

Radius of the test ripple, in world space

TestRippleSpeed Source code

Angular speed of the test ripple

FluidDetail

bTiling Source code

Whether to make the detail simulation tiled.

DetailDamping Source code

How much to dampen the amplitude of waves in the detail texture (0.0-30.0)

DetailHeightScale Source code

Wave height scale for the detail texture - higher value produces higher waves

DetailResolution Source code

Number of simulation cells along each axis in the detail texture

DetailSize Source code

World space size of one edge of the detail texture

DetailTransfer Source code

How much of an applied force should be transferred to the detail texture (0.0-1.0)

DetailTravelSpeed Source code

Wave travel speed factor for the detail texture (0.0-1.0)

DetailUpdateRate Source code

Fluid update rate in number of updates per second

FluidSurfaceComponent

FluidMaterial Source code

Surface material

Lighting

LightmapResolution Source code

Resolution of the fluid's texture lightmap.

Lightmass

LightmassSettings Source code

The Lightmass settings for this object.

ApplyForce Source code

Apply a force to the fluid.

SetDetailPosition Source code

Set the position of the origin of the detail texture, within the fluid.

SetSimulationPosition Source code

Set the position of the origin of the simulation grid, within the fluid.

defaultproperties
{
	LightmapResolution=128
	EnableSimulation=true
	EnableDetail=true
	DeactivationDistance=3000.0
	FluidUpdateRate=30.0
	DetailUpdateRate=30.0
	bTiling=false
	FluidHeightScale=1.0
	DetailHeightScale=1.0
	bPause=false
	SimulationQuadsX=200
	SimulationQuadsY=200
	GridSpacing=10.0
	GridSpacingLowRes=800.0
	DetailResolution=256
	DetailSize=500
	FluidDamping=1.0
	FluidTravelSpeed=1.0
	DetailDamping=1.0
	DetailTravelSpeed=1.0
	DetailTransfer=0.5
	bTestRipple=false
	TestRippleSpeed=1
	TestRippleRadius=30
	TestRippleFrequency=1.0
	bShowFluidDetail=true
	bShowFluidSimulation=true
	bShowDetailNormals=false
	bShowDetailPosition=false
	bShowSimulationNormals=false
	bShowSimulationPosition=false
	NormalLength=10.0
	LightingContrast=1.0
	GPUTessellationFactor=1.0

	ForceImpact=-3.0
	ForceContinuous=-200.0

	FluidWidth=2000.0
	FluidHeight=2000.0
	TestRippleTime=0.0
	TestRippleAngle=0.0
	DeactivationTimer=10.0
	ViewDistance=0.0

	bTickInEditor=true
	CollideActors=true
	BlockZeroExtent=true
	BlockNonZeroExtent=true
	BlockRigidBody=false

	CastShadow=false
	bForceDirectLightMap=true
	bAcceptsLights=true
	bUsePrecomputedShadows=true

	
	bIgnoreNearPlaneIntersection=true
}