1. Epic GamesDeveloper
  3. UWaterBodyOceanComponent

UWaterBodyOceanComponent

Unreal Engine C++ API Reference > Plugins > Water

Inheritance Hierarchy

References

   
Module Water
Header /Engine/Plugins/Experimental/Water/Source/Runtime/Public/WaterBodyOceanComponent.h
Include #include "WaterBodyOceanComponent.h"

Syntax

UCLASS (Blueprintable)  
class UWaterBodyOceanComponent : public UWaterBodyComponent

Variables

  Type Name Description
Protected variable UProperty Category, EditAnywhere, AdvancedDisplay bool bCenterOnWaterZone If enabled, oceans will always center their mesh/bounds on the owning water zone by using a saved location that is updated whenever the ocean mesh is rebuilt.
Protected variable UProperty nonpieduplicatetransient TArray< TObjectPtr< UOceanBoxCollisionComponent > > CollisionBoxes  
Protected variable UProperty Category, EditAnywhere BlueprintReadOnly FVector CollisionExtents  
Protected variable UProperty nonpieduplicatetransient TArray< TObjectPtr< UOceanCollisionComponent > > CollisionHullSets  
Protected variable UProperty Transient float HeightOffset  
Protected variable UProperty Category, EditAnywhere BlueprintReadOnly FVector2D OceanExtents The extent of the ocean, centered around water zone to which the ocean belongs.
Protected variable UProperty FVector2D SavedZoneLocation Saved water zone location so that the ocean mesh can be regenerated relative to it and match it perfectly without being loaded.

Constructors

  Type Name Description
Public function  

UWaterBodyOceanComponent ( const FObjectInitializer& ObjectInitializer
)

  

Functions

  Type Name Description
Public function UFunction Category callineditor void Rebuilds the ocean mesh to completely fill the zone to which it belongs.
Public function Const FVector2D  
Public function void

SetCollisionExtents ( const FVector& NewExtents
)

  
Public function void

SetOceanExtent ( const FVector2D& NewExtents
)

  
Public function void  

Overridden from UWaterBodyComponent

  Type Name Description
Protected function Virtual void Called every time UpdateAll is called on WaterBody (prior to UpdateWaterBody)
Protected function Virtual TArray< TSharedRef< FTokenizedMessage > >  
Protected function Virtual Const bool Generates the mesh representation of the water body
Public function Virtual Const TArray< UPrimitiveComponent * >

GetCollisionComponents ( bool bInOnlyEnabledComponents
)

 Returns body's collision components
Public function Virtual Const FVector Returns collision half-extents
Public function Virtual Const float Returns the additional water height added to the body (For internal use. Please use AWaterBodyOcean instead.)
Public function Virtual Const EWaterBodyType UWaterBodyComponent Interface
Protected function Virtual Const const TCHAR *  
Protected function Virtual Const bool UWaterBodyComponent Interface
Protected function Virtual void Called by the owning actor when it receives a PostActorCreated callback
Protected function Virtual void

OnPostEditChangeProperty ( FOnWaterBodyChangedParams& InOutOnWaterBodyChangedParams
)

  
Protected function Virtual void Called when the WaterBodyActor has had all its components registered.
Protected function Virtual void

OnUpdateBody ( bool bWithExclusionVolumes
)

  
Protected function Virtual void  
Protected function Virtual void

Reset ()

  
Public function Virtual void

SetHeightOffset ( float InHeightOffset
)

 Sets an additional water height (For internal use. Please use AWaterBodyOcean instead.)

Overridden from USceneComponent

  Type Name Description
Protected function Virtual Const FBoxSphereBounds

CalcBounds ( const FTransform& LocalToWorld
)

 Calculate the bounds of the component. Default behavior is a bounding box/sphere of zero size.

Overridden from UObject

  Type Name Description
Protected function Virtual void Do any object-specific cleanup required immediately after loading an object.

Deprecated Variables

  Type Name Description
Protected variable UProperty FVector2D VisualExtents_DEPRECATED  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page