FhSim  3.1.0
Marine systems simulation
Loading...
Searching...
No Matches
environmentmodels::VisualScalarPlane Class Reference
+ Inheritance diagram for environmentmodels::VisualScalarPlane:
+ Collaboration diagram for environmentmodels::VisualScalarPlane:

Public Member Functions

 VisualScalarPlane (std::string SimObjectName, ISimObjectCreator *Creator)
 
 ~VisualScalarPlane () override
 Releases the plane geometry; the base releases the material and the textures.
 
- Public Member Functions inherited from environmentmodels::VisualBakedScalarField
void FinalSetup (const double T, const double *const X, ISimObjectCreator *Creator) override
 
void OdeFcn (const double T, const double *const X, double *const XDot) const override
 No state; the ODE function is a no-op.
 

Additional Inherited Members

- Protected Member Functions inherited from environmentmodels::VisualBakedScalarField
 VisualBakedScalarField (std::string SimObjectName, ISimObjectCreator *Creator, int numAxes)
 
 ~VisualBakedScalarField () override
 Releases the cloned material and the baked textures.
 
void ResolveCounts (const double extent[3], std::size_t budget, int counts[3]) const
 
void ValidateGridCounts (ISimObjectCreator *Creator, const int counts[3], const std::string &extentParameterName) const
 
bool MaskInaccurate () const
 
environment::field::ScalarField & Field () const
 

Constructor & Destructor Documentation

◆ VisualScalarPlane()

environmentmodels::VisualScalarPlane::VisualScalarPlane ( std::string  SimObjectName,
ISimObjectCreator *  Creator 
)

Construct a scalar field plane.

Parameters
[in]SimObjectNameUnique name for this simulation object.
[in]CreatorObject creator/registry.
Exceptions
std::runtime_errorwhen a parameter is missing, contradictory, names a degenerate plane frame, or asks for a grid the render system could not hold.

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