SIM_MaskField Class Reference

This class defines the interface for field mask functions. More...

#include <SIM_MaskField.h>

Inheritance diagram for SIM_MaskField:

List of all members.

Public Member Functions
	GETSET_DATA_FUNCS_B (SIM_NAME_TREATASSDF, TreatAsSDF)
	GETSET_DATA_FUNCS_B (SIM_NAME_INVERT, InvertSign)
	GETSET_DATA_FUNCS_F (SIM_NAME_OFFSET, Offset)
	GETSET_DATA_FUNCS_F (SIM_NAME_SCALE, Scale)
	GETSET_DATA_FUNCS_F (SIM_NAME_MAXDISTANCE, MaxDistance)
	The maximum distance we are allowed to search for a point.
Protected Member Functions
	SIM_MaskField (const SIM_DataFactory *factory)
virtual	~SIM_MaskField ()
virtual void	getNoiseLimitsSubclass (fpreal &min, fpreal &max) const
	Override this function to return the actual bounds of the noise.
virtual fpreal	getNoiseSubclass (const UT_Vector3 &pos) const
	Override this function to implement a new 1D noise function.
virtual void	getNoiseSubclass (const UT_Vector3 &pos, UT_Vector3 &noise) const
	Override this function to implement a new 3D noise function.

---

Detailed Description

This class defines the interface for field mask functions.

Definition at line 22 of file SIM_MaskField.h.

---

Constructor & Destructor Documentation

SIM_MaskField::SIM_MaskField

(

const SIM_DataFactory *

factory

)

[explicit, protected]

virtual SIM_MaskField::~SIM_MaskField

(

)

[protected, virtual]

---

Member Function Documentation

virtual void SIM_MaskField::getNoiseLimitsSubclass	(	fpreal &	min,
		fpreal &	max
	)			const [protected, virtual]

Override this function to return the actual bounds of the noise.

Implements SIM_Noise.

virtual void SIM_MaskField::getNoiseSubclass	(	const UT_Vector3 &	pos,
		UT_Vector3 &	noise
	)			const [protected, virtual]

Override this function to implement a new 3D noise function.

Reimplemented from SIM_Noise.

virtual fpreal SIM_MaskField::getNoiseSubclass

(

const UT_Vector3 &

pos

)

const [protected, virtual]

Override this function to implement a new 1D noise function.

Reimplemented from SIM_Noise.

SIM_MaskField::GETSET_DATA_FUNCS_B	(	SIM_NAME_INVERT	,
		InvertSign
	)

SIM_MaskField::GETSET_DATA_FUNCS_B	(	SIM_NAME_TREATASSDF	,
		TreatAsSDF
	)

SIM_MaskField::GETSET_DATA_FUNCS_F	(	SIM_NAME_MAXDISTANCE	,
		MaxDistance
	)

The maximum distance we are allowed to search for a point.

SIM_MaskField::GETSET_DATA_FUNCS_F	(	SIM_NAME_SCALE	,
		Scale
	)

SIM_MaskField::GETSET_DATA_FUNCS_F	(	SIM_NAME_OFFSET	,
		Offset
	)

---

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

• SIM/SIM_MaskField.h