Navigation
API > API/Plugins > API/Plugins/Water
| Name | UWaterBodyOceanComponent |
| Type | class |
| Header File | /Engine/Plugins/Experimental/Water/Source/Runtime/Public/WaterBodyOceanComponent.h |
| Include Path | #include "WaterBodyOceanComponent.h" |
Syntax
UCLASS (MinimalAPI, Blueprintable)
class UWaterBodyOceanComponent : public UWaterBodyComponent
Inheritance Hierarchy
- UObjectBase → UObjectBaseUtility → UObject → UActorComponent → USceneComponent → UPrimitiveComponent → UWaterBodyComponent → UWaterBodyOceanComponent
Implements Interfaces
- IAsyncPhysicsStateProcessor
- IInterface_AssetUserData
- IInterface_AsyncCompilation
- INavRelevantInterface
- IPhysicsComponent
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
UWaterBodyOceanComponent
(
const FObjectInitializer& ObjectInitializer |
WaterBodyOceanComponent.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
void FillWaterZoneWithOcean() |
Rebuilds the ocean mesh to completely fill the zone to which it belongs. | WaterBodyOceanComponent.h |
|
void SetCollisionExtents
(
const FVector& NewExtents |
WaterBodyOceanComponent.h | ||
void SetOceanExtent
(
const FVector2D& NewExtents |
WaterBodyOceanComponent.h |
Overridden from UWaterBodyComponent
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual TArray< UPrimitiveComponent * > GetCollisionComponents
(
bool bInOnlyEnabledComponents |
Returns body's collision components | WaterBodyOceanComponent.h | |
virtual FVector GetCollisionExtents() |
Returns collision half-extents | WaterBodyOceanComponent.h | |
virtual float GetHeightOffset() |
Returns the additional water height added to the body (For internal use. Please use AWaterBodyOcean instead.) | WaterBodyOceanComponent.h | |
virtual EWaterBodyType GetWaterBodyType() |
UWaterBodyComponent Interface | WaterBodyOceanComponent.h | |
virtual void SetHeightOffset
(
float InHeightOffset |
Sets an additional water height (For internal use. Please use AWaterBodyOcean instead.) | WaterBodyOceanComponent.h |
Protected
Overridden from UWaterBodyComponent
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual void BeginUpdateWaterBody() |
Called every time UpdateAll is called on WaterBody (prior to UpdateWaterBody) | WaterBodyOceanComponent.h | |
virtual TArray< TSharedRef< FTokenizedMessage > > CheckWaterBodyStatus() |
WaterBodyOceanComponent.h | ||
virtual bool GenerateWaterBodyMesh
(
UE::Geometry::FDynamicMesh3& OutMesh, |
Generates the mesh representation of the water body | WaterBodyOceanComponent.h | |
virtual const TCHAR * GetWaterSpriteTextureName() |
WaterBodyOceanComponent.h | ||
virtual bool IsBodyDynamic() |
UWaterBodyComponent Interface | WaterBodyOceanComponent.h | |
virtual void OnPostActorCreated() |
Called by the owning actor when it receives a PostActorCreated callback | WaterBodyOceanComponent.h | |
virtual void OnPostEditChangeProperty
(
FOnWaterBodyChangedParams& InOutOnWaterBodyChangedParams |
Called by UWaterBodyComponent::PostEditChangeProperty. | WaterBodyOceanComponent.h | |
virtual void OnPostRegisterAllComponents() |
Called when the WaterBodyActor has had all its components registered. | WaterBodyOceanComponent.h | |
virtual void OnUpdateBody
(
bool bWithExclusionVolumes |
WaterBodyOceanComponent.h | ||
virtual void OnWaterBodyRenderDataUpdated() |
WaterBodyOceanComponent.h | ||
virtual void Reset() |
WaterBodyOceanComponent.h |
Overridden from USceneComponent
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual FBoxSphereBounds CalcBounds
(
const FTransform& LocalToWorld |
WaterBodyOceanComponent.h |
Overridden from UObject
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual void PostLoad() |
WaterBodyOceanComponent.h |
Deprecated Variables
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| VisualExtents_DEPRECATED | FVector2D | WaterBodyOceanComponent.h |