|
|
|
River Class Reference
[Water]
A water volume defined by a 3D spline. More...
Public Member Functions | |
| void | regenerate () |
| 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. | |
Public Attributes | |
River | |
| 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. | |
| 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. | |
Internal | |
| string | Node |
| For internal use, do not modify. | |
Static Public Attributes | |
| static bool | EditorOpen |
| For editor use. | |
| static bool | isRenderable |
| Disables rendering of all instances of this type. | |
| static bool | isSelectable |
| Disables selection of all instances of this type. | |
| static bool | showNodes |
| For editor use. | |
| static bool | showRiver |
| For editor use. | |
| static bool | showSpline |
| For editor use. | |
| static bool | showWalls |
| For editor use. | |
| static bool | showWireframe |
| For editor use. | |
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.
- See also:
- WaterObject for inherited functionality.
Member Function Documentation
| void River::regenerate | ( | ) |
Intended as a helper to developers and editor scripts.
Force River to recreate its geometry.
| void River::setBatchSize | ( | float | meters | ) |
Intended as a helper to developers and editor scripts.
BatchSize is not currently used.
| void River::setMaxDivisionSize | ( | float | meters | ) |
Intended as a helper to developers and editor scripts.
- See also:
- SubdivideLength field.
| void River::setMetersPerSegment | ( | float | meters | ) |
Intended as a helper to developers and editor scripts.
- See also:
- SegmentLength field.
| void River::setNodeDepth | ( | int | idx, | |
| float | meters | |||
| ) |
Intended as a helper to developers and editor scripts.
Sets the depth in meters of a particular node.
Member Data Documentation
bool River::EditorOpen [static] |
For editor use.
| float River::FlowMagnitude |
Magnitude of the force vector applied to dynamic objects within the River.
| float River::LowLODDistance |
Segments of the river at this distance in meters or greater will render as a single unsubdivided without undulation effects.
| string River::Node |
For internal use, do not modify.
| float River::SegmentLength |
Divide the River lengthwise into segments of this length in meters. These geometric volumes are used for spacial queries like determining containment.
bool River::showNodes [static] |
For editor use.
bool River::showRiver [static] |
For editor use.
bool River::showSpline [static] |
For editor use.
bool River::showWalls [static] |
For editor use.
bool River::showWireframe [static] |
For editor use.
| float River::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.