Inheritance diagram for environmentmodels::VisualFieldPlane:

Collaboration diagram for environmentmodels::VisualFieldPlane:

Public Member Functions
	VisualFieldPlane (std::string SimObjectName, ISimObjectCreator *Creator)

	~VisualFieldPlane () override
	Releases the plane geometry; the base releases the material and the textures.

Public Member Functions inherited from environmentmodels::VisualField
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.

util::Refresh	RefreshMode () const

Additional Inherited Members
Protected Member Functions inherited from environmentmodels::VisualField
	VisualField (std::string SimObjectName, ISimObjectCreator *Creator, int numAxes)

	~VisualField () override
	Releases the cloned material and the 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

bool	ExpectsToSampleOnce () const

bool	MaySampleInTheBackground () const

environment::field::ScalarField &	Field () const

double	StartTime () const
	Simulation time of FinalSetup [s], the time of the first sample.

bool	RefreshDue (double T, bool moved) const

void	Refreshed (double T)

util::BakedField	SampleOver (double T, const util::SamplingBox &box)

double	ValueMin () const
	Field value encoded as code 1, fixed at the first SampleOver().

double	ValueMax () const
	Field value encoded as code 65535, fixed at the first SampleOver().

Constructor & Destructor Documentation

◆ VisualFieldPlane()

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

Construct a field plane.

Parameters

[in]	SimObjectName	Unique name for this simulation object.
[in]	Creator	Object creator/registry.

Exceptions

std::runtime_error when 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: