PRM_Default Class Reference

#include <PRM_Default.h>

List of all members.

Public Member Functions
	PRM_Default (fpreal thefloat=0.0F, const char *thestring=0, CH_StringMeaning string_meaning=CH_STRING_LITERAL)
fpreal	getFloat () const
int	getOrdinal () const
bool	gotString () const
const char *	getString () const
CH_StringMeaning	getStringMeaning () const
PRM_Default &	operator= (const PRM_Default &dft)
void	set (fpreal thefloat, const char *thestring, CH_StringMeaning string_meaning)
void	setFloat (fpreal v)
void	setOrdinal (int v)
void	setString (const char *v, bool free_existing=false)
void	setStringMeaning (CH_StringMeaning string_meaning)

---

Detailed Description

Examples:

CHOP/CHOP_Spring.C, CHOP/CHOP_Stair.C, COP2/COP2_FullImageFilter.C, COP2/COP2_MultiInputWipe.C, field3d/ROP_Field3D.C, OBJ/OBJ_Shake.C, POP/POP_LocalForce.C, POP/POP_RadialBirth.C, ROP/ROP_DopField.C, ROP/ROP_Dumper.C, SOP/SOP_CopRaster.C, SOP/SOP_CustomBrush.C, SOP/SOP_DetailAttrib.C, SOP/SOP_IKSample.C, SOP/SOP_PrimVOP.C, SOP/SOP_SParticle.C, SOP/SOP_Star.C, SOP/SOP_TimeCompare.C, and VOP/VOP_CustomContext.C.

Definition at line 49 of file PRM_Default.h.

---

Constructor & Destructor Documentation

PRM_Default::PRM_Default	(	fpreal	thefloat = 0.0F,
		const char *	thestring = 0,
		CH_StringMeaning	string_meaning = CH_STRING_LITERAL
	)

PRM_Default has two parts: a float and a string. For floating point parameters, if the default string is defined, then the parameter will start off being animated and have the channel expression defined by the string. Otherwise, the floating point default is used for float and integer types, while the string is used to initialize string types.

---

Member Function Documentation

fpreal PRM_Default::getFloat

(

)

const [inline]

Definition at line 61 of file PRM_Default.h.

int PRM_Default::getOrdinal

(

)

const [inline]

Definition at line 62 of file PRM_Default.h.

const char* PRM_Default::getString

(

)

const [inline]

Definition at line 64 of file PRM_Default.h.

CH_StringMeaning PRM_Default::getStringMeaning

(

)

const [inline]

Definition at line 65 of file PRM_Default.h.

bool PRM_Default::gotString

(

)

const [inline]

Definition at line 63 of file PRM_Default.h.

PRM_Default& PRM_Default::operator=

(

const PRM_Default &

dft

)

void PRM_Default::set	(	fpreal	thefloat,
		const char *	thestring,
		CH_StringMeaning	string_meaning
	)

void PRM_Default::setFloat

(

fpreal

v

)

[inline]

Definition at line 73 of file PRM_Default.h.

void PRM_Default::setOrdinal

(

int

v

)

[inline]

Definition at line 74 of file PRM_Default.h.

void PRM_Default::setString	(	const char *	v,
		bool	free_existing = false
	)

void PRM_Default::setStringMeaning

(

CH_StringMeaning

string_meaning

)

---

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

• PRM/PRM_Default.h