enlighten.timing.Ramp.Ramp Class Reference

Provides a generic ramp that ticks a callback with ascending/descending value at a specified rate. More...

Public Member Functions
	__init__ (self, callback, name="unknown")
	start (self, start_value, end_value, seconds)
	stop (self)
	tick (self)

Public Attributes
bool	ascending = end_value > start_value
	callback = callback
	delay_ms = int(float(seconds * 1000) / abs(end_value - start_value))
	end_value = end_value
	name = name
bool	running = False
	start_value = start_value
	tick
	timer = QtCore.QTimer()
	value = self.start_value

Detailed Description

Provides a generic ramp that ticks a callback with ascending/descending value at a specified rate.

Constructor & Destructor Documentation

__init__()

enlighten.timing.Ramp.Ramp.__init__	(		self,
			callback,
			name = "unknown" )

Member Function Documentation

start()

enlighten.timing.Ramp.Ramp.start	(		self,
			start_value,
			end_value,
			seconds )

stop()

enlighten.timing.Ramp.Ramp.stop

(

self

)

tick()

enlighten.timing.Ramp.Ramp.tick

(

self

)

Member Data Documentation

ascending

bool enlighten.timing.Ramp.Ramp.ascending = end_value > start_value

callback

enlighten.timing.Ramp.Ramp.callback = callback

delay_ms

enlighten.timing.Ramp.Ramp.delay_ms = int(float(seconds * 1000) / abs(end_value - start_value))

end_value

enlighten.timing.Ramp.Ramp.end_value = end_value

name

enlighten.timing.Ramp.Ramp.name = name

running

bool enlighten.timing.Ramp.Ramp.running = False

start_value

enlighten.timing.Ramp.Ramp.start_value = start_value

tick

enlighten.timing.Ramp.Ramp.tick

timer

enlighten.timing.Ramp.Ramp.timer = QtCore.QTimer()

value

enlighten.timing.Ramp.Ramp.value = self.start_value

---

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

• enlighten/timing/Ramp.py