River
A water volume defined by a 3D spline.
River
float
Divide the River lengthwise into segments of this length in meters. These geometric volumes are used for spacial queries like determining containment.
float
For purposes of generating the renderable geometry River segments are further subdivided such that no quad is of greater width or length than this distance in meters.
float
Magnitude of the force vector applied to dynamic objects within the River.
float
Segments of the river at this distance in meters or greater will render as a single unsubdivided without undulation effects.
Internal
string
For internal use, do not modify.
Public Static Attributes
bool
For editor use.
bool
Disables rendering of all instances of this type.
bool
Disables selection of all instances of this type.
bool
For editor use.
bool
For editor use.
bool
For editor use.
bool
For editor use.
bool
For editor use.
Public Functions
void
Intended as a helper to developers and editor scripts.
void
setBatchSize(float meters)
Intended as a helper to developers and editor scripts.
void
setMaxDivisionSize(float meters)
Intended as a helper to developers and editor scripts.
void
setMetersPerSegment(float meters)
Intended as a helper to developers and editor scripts.
void
setNodeDepth(int idx, float meters)
Intended as a helper to developers and editor scripts.
Detailed Description
A water volume defined by a 3D spline.
User may control width and depth per node and overall spline shape in three dimensions.
River supports dynamic planar reflections (fullReflect) like all WaterObject classes, but keep in mind it is not necessarily a planar surface. For best visual quality a River should be less reflective the more it twists and bends. This caution only applies to Rivers with fullReflect on.
WaterObject for inherited functionality.
River
float SegmentLength
Divide the River lengthwise into segments of this length in meters. These geometric volumes are used for spacial queries like determining containment.
float SubdivideLength
For purposes of generating the renderable geometry River segments are further subdivided such that no quad is of greater width or length than this distance in meters.
float FlowMagnitude
Magnitude of the force vector applied to dynamic objects within the River.
float LowLODDistance
Segments of the river at this distance in meters or greater will render as a single unsubdivided without undulation effects.
Internal
string Node
For internal use, do not modify.
Public Static Attributes
bool EditorOpen
For editor use.
bool isRenderable
Disables rendering of all instances of this type.
bool isSelectable
Disables selection of all instances of this type.
bool showNodes
For editor use.
bool showRiver
For editor use.
bool showSpline
For editor use.
bool showWalls
For editor use.
bool showWireframe
For editor use.
Public Functions
regenerate()
Intended as a helper to developers and editor scripts.
Force River to recreate its geometry.
setBatchSize(float meters)
Intended as a helper to developers and editor scripts.
BatchSize is not currently used.
setMaxDivisionSize(float meters)
Intended as a helper to developers and editor scripts.
SubdivideLength field.
setMetersPerSegment(float meters)
Intended as a helper to developers and editor scripts.
SegmentLength field.
setNodeDepth(int idx, float meters)
Intended as a helper to developers and editor scripts.
Sets the depth in meters of a particular node.