OceanModifier(Modifier)
base classes — bpy_struct, Modifier
-
class bpy.types.OceanModifier(Modifier)
Simulate an ocean surface
-
bake_foam_fade
| Type : | float in [0, inf], default 0.0 |
|---|
-
choppiness
| Type : | float in [0, inf], default 0.0 |
|---|
-
damping
Damp reflected waves going in opposite direction to the wind
| Type : | float in [0, 1], default 0.0 |
|---|
-
depth
| Type : | float in [0, inf], default 0.0 |
|---|
-
filepath
Path to a folder to store external baked images
| Type : | string, default “”, (never None) |
|---|
-
foam_coverage
| Type : | float in [-inf, inf], default 0.0 |
|---|
-
foam_layer_name
Name of the vertex color layer used for foam
| Type : | string, default “”, (never None) |
|---|
-
frame_end
| Type : | int in [0, inf], default 0 |
|---|
-
frame_start
| Type : | int in [0, inf], default 0 |
|---|
-
geometry_mode
Method of modifying geometry
- GENERATE Generate, Generate ocean surface geometry at the specified resolution.
- DISPLACE Displace, Displace existing geometry according to simulation.
| Type : | enum in [‘GENERATE’, ‘DISPLACE’], default ‘GENERATE’ |
|---|
-
is_build_enabled
True if the OceanSim modifier is enabled in this build
| Type : | boolean, default False, (readonly) |
|---|
-
is_cached
Whether the ocean is using cached data or simulating
| Type : | boolean, default False, (readonly) |
|---|
-
random_seed
| Type : | int in [0, inf], default 0 |
|---|
-
repeat_x
Repetitions of the generated surface in X
| Type : | int in [1, 1024], default 0 |
|---|
-
repeat_y
Repetitions of the generated surface in Y
| Type : | int in [1, 1024], default 0 |
|---|
-
resolution
Resolution of the generated surface
| Type : | int in [1, 1024], default 0 |
|---|
-
size
| Type : | float in [0, inf], default 0.0 |
|---|
-
spatial_size
Physical size of the simulation domain (m)
| Type : | int in [-inf, inf], default 0 |
|---|
-
time
| Type : | float in [0, inf], default 0.0 |
|---|
-
use_foam
Generate foam mask as a vertex color channel
| Type : | boolean, default False |
|---|
-
use_normals
Output normals for bump mapping - disabling can speed up performance if its not needed
| Type : | boolean, default False |
|---|
-
wave_alignment
| Type : | float in [0, 10], default 0.0 |
|---|
-
wave_direction
| Type : | float in [-inf, inf], default 0.0 |
|---|
-
wave_scale
| Type : | float in [0, inf], default 0.0 |
|---|
-
wave_scale_min
Shortest allowed wavelength (m)
| Type : | float in [0, inf], default 0.0 |
|---|
-
wind_velocity
Wind speed (m/s)
| Type : | float in [-inf, inf], default 0.0 |
|---|
Inherited Properties
Inherited Functions