MR.Const_FlowAggregator Class Reference

this class can track multiple flows and find in each mesh vertex the amount of water reached it Generated from class MR.FlowAggregator. This is the const half of the class. More...

Inheritance diagram for MR.Const_FlowAggregator:

Classes
class	_ByValue_Flows
	This is used as a function parameter when the underlying function receives Flows by value. Usage: More...
class	_InOptConst_Flows
	This is used for optional parameters of class Flows with default arguments. This is only used const parameters. For non-const ones we have _InOptMut_Flows. Usage: More...
class	_InOptMut_Flows
	This is used for optional parameters of class Flows with default arguments. This is only used mutable parameters. For const ones we have _InOptConst_Flows. Usage: More...
struct	_Underlying
class	Const_Flows
	Generated from class MR.FlowAggregator.Flows. This is the const half of the class. More...
class	Flows
	Generated from class MR.FlowAggregator.Flows. This is the non-const half of the class. More...

Public Member Functions
virtual void	Dispose ()
unsafe	Const_FlowAggregator (MR._ByValue_FlowAggregator _other)
	Generated from constructor MR.FlowAggregator.FlowAggregator.
unsafe	Const_FlowAggregator (MR.Const_Mesh mesh, MR.Const_VertScalars heights)
	prepares the processing of given mesh with given height in each vertex Generated from constructor MR.FlowAggregator.FlowAggregator.
unsafe MR.VertScalars	computeFlow (MR.Std.Const_Vector_MRFlowOrigin starts, MR.Const_OutputFlows? out_=null)
	tracks multiple flows
unsafe MR.VertScalars	computeFlow (MR.Std.Const_Vector_MRMeshTriPoint starts, MR.Const_OutputFlows? out_=null)
	Generated from method MR.FlowAggregator.computeFlow. Parameter out_ defaults to {}.
unsafe MR.VertScalars	computeFlow (ulong numStarts, MR.Std.Const_Function_MRMeshTriPointFuncFromMRUint64T startById, MR.Std.Const_Function_FloatFuncFromMRUint64T amountById, MR.Std.Const_Function_ConstMRFaceBitSetPtrFuncFromMRUint64T regionById, MR.Const_OutputFlows? out_=null)
	Generated from method MR.FlowAggregator.computeFlow. Parameter out_ defaults to {}.
unsafe MR.Phmap.FlatHashMap_MRVertId_MRFlowAggregatorFlows	computeFlowsPerBasin (MR.Std.Const_Vector_MRFlowOrigin starts)
	tracks multiple flows
unsafe MR.Phmap.FlatHashMap_MRVertId_MRFlowAggregatorFlows	computeFlowsPerBasin (MR.Std.Const_Vector_MRMeshTriPoint starts)
	Generated from method MR.FlowAggregator.computeFlowsPerBasin.
unsafe MR.Phmap.FlatHashMap_MRVertId_MRFlowAggregatorFlows	computeFlowsPerBasin (ulong numStarts, MR.Std.Const_Function_MRMeshTriPointFuncFromMRUint64T startById, MR.Std.Const_Function_FloatFuncFromMRUint64T amountById)
	Generated from method MR.FlowAggregator.computeFlowsPerBasin.
unsafe MR.UndirectedEdgeBitSet	computeCatchmentDelineation ()
	finds the edges on the mesh that divides catchment basin (every triangle is attributed to the final destination point based on the path originated from its centroid) Generated from method MR.FlowAggregator.computeCatchmentDelineation.

Protected Member Functions
virtual unsafe void	Dispose (bool disposing)

Additional Inherited Members
Protected Attributes inherited from MR.Misc.Object< Const_FlowAggregator >
bool	_IsOwningVal
Properties inherited from MR.Misc.Object< Const_FlowAggregator >
virtual bool	_IsOwning [get]
	Returns true if this is an owning instance, and when disposed, will destroy the underlying C++ instance. If false, we assume that the underlying C++ instance will live long enough.

Detailed Description

this class can track multiple flows and find in each mesh vertex the amount of water reached it Generated from class MR.FlowAggregator. This is the const half of the class.

Member Function Documentation

computeFlow()

unsafe MR.VertScalars MR.Const_FlowAggregator.computeFlow ( MR.Std.Const_Vector_MRFlowOrigin starts, MR.Const_OutputFlows? out_ = null )

inline

tracks multiple flows

Parameters

starts

the origin of each flow (should be uniformly sampled over the terrain)

Returns

the flow reached each mesh vertex Generated from method MR.FlowAggregator.computeFlow. Parameter out_ defaults to {}.

computeFlowsPerBasin()

unsafe MR.Phmap.FlatHashMap_MRVertId_MRFlowAggregatorFlows MR.Const_FlowAggregator.computeFlowsPerBasin ( MR.Std.Const_Vector_MRFlowOrigin starts )

inline

tracks multiple flows

Parameters

starts

the origin of each flow (should be uniformly sampled over the terrain)

Returns

the flows grouped by the final destination vertex Generated from method MR.FlowAggregator.computeFlowsPerBasin.

---

The documentation for this class was generated from the following file:

• MRAggregateFlow.cs