ParamDef Class Reference

Inherits object.

Collaboration diagram for ParamDef:

Public Member Functions
def	__init__ (self, name, desc, ptype, default=None, minv=None, maxv=None, step=None, notNone=False)
def	getErrorStr (self, val)
def	__repr__ (self)

Static Public Member Functions
def	validateArgMap (params, argmap)

Public Attributes
	name
	desc
	ptype
	default
	minv
	maxv
	step
	notNone

Detailed Description

Definition of a parameter for various uses, eg. representation object settings, UI definitions. Parameters consist
of a name, description (for use in tooltips), a value type such as str or int, default value, value range, value
step, and whether None is accepted as a value. A ParamDef represents a named value of some sort defined within these
parameters, this can be used to define a generic interface for parameters into objects and to automatically define
GUI elements for inputting these values.

Constructor & Destructor Documentation

__init__()

def __init__	(		self,
			name,
			desc,
			ptype,
			default = None,
			minv = None,
			maxv = None,
			step = None,
			notNone = False
	)

Member Function Documentation

__repr__()

def __repr__

(

self

)

getErrorStr()

def getErrorStr	(		self,
			val
	)

Here is the call graph for this function:

validateArgMap()

def validateArgMap (   params,   argmap  )

static

Member Data Documentation

default

default

desc

desc

maxv

maxv

minv

minv

name

name

notNone

notNone

ptype

ptype

step

step

---

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

• eidolon/Utils.py