Unigine.PhysicalWater Class
| Inherits: | Physical |
A PhysicalWater class is used to simulate water interaction effects.
Notice
The water will affect only objects, to which a cloth body or a rigid body are assigned.
If the rigid body is used, a shape should be also assigned.
See Also#
- An article on Physical Water
- A set of samples located in the <UnigineSDK>/data/samples/physicals folder:
- water_00
- water_01
PhysicalWater Class
Properties
vec3 Velocity#
The current velocity of the flow in physical water.
set
Sets a velocity of the flow in physical water.
set value -
Velocity in units per second.
vec3 Size#
The current size of the physical water node.
set
Sets a size of the physical water node.
set value -
Water box size in units.
int NumContacts#
The number of contacts between the physical water and the objects.
float LinearDamping#
The current value indicating how much the linear velocity of the objects decreases when they get into the physical water.
set
Sets a value indicating how much the linear velocity of the objects decreases when they get into the physical water.
set value -
Linear damping value. If a negative value is provided, 0 will be used instead.
float Density#
The current density of the physical water that determines objects buoyancy.
set
Sets a density of the water that determines objects buoyancy.
set value -
Density value. If a negative value is provided, 0 will be used instead.
float AngularDamping#
The current value indicating how much the angular velocity of the objects decreases when they get into the physical water.
set
Sets a value indicating how much the angular velocity of the objects decreases when they get into the physical water.
set value -
Angular damping value. If a negative value is provided, 0 will be used instead.
Members
static PhysicalWater ( vec3 size ) #
Constructor. Creates a physical water node of the specified size.Arguments
- vec3 size - Water box size in units.
Body GetContactBody ( int num ) #
Returns the body of the object by the given contact with physical water.Arguments
- int num - Contact number.
Return value
Body of the object.float GetContactDepth ( int num ) #
Returns the depth of the object submergence by the given contact.Arguments
- int num - Contact number.
Return value
Depth of object submergence in units.vec3 GetContactForce ( int num ) #
Returns the force in the point of a given contact.Arguments
- int num - Contact number.
Return value
Force value.vec3 GetContactPoint ( int num ) #
Returns the coordinates of the contact point.Arguments
- int num - Contact number.
Return value
Contact point coordinates.vec3 GetContactVelocity ( int num ) #
Returns the relative velocity between the object and the physical water.Arguments
- int num - Contact number.
Return value
Relative velocity in units per second.static int type ( ) #
Returns the type of the node.Return value
Physical type identifier.Last update:
2020-11-24
Help improve this article
Was this article helpful?
(or select a word/phrase and press Ctrl+Enter)