| | |
- Event(object)
-
- TimeEvent
-
- CycleEvent
- FractionalEvent
- PauseEvent
- ResumeEvent
- StartEvent
- StopEvent
class CycleEvent(TimeEvent) |
| |
Event generated when the internal time reaches cycle boundary
This event is generated:
* when an InternalTime reaches a cycle boundary
which does not cause a StopEvent (i.e. when
the InternalTime continues past a cycle
boundary)
If the InternalTime generates fractional events,
then a fractional event will be generated at the
same time as the CycleEvent
|
| |
- Method resolution order:
- CycleEvent
- TimeEvent
- Event
- object
Data and other attributes defined here:
- timetype = 'cycle'
Methods inherited from TimeEvent:
- __init__(self, internal)
- Initialize the TimeEvent
internal -- pointer to the InternalTime object which
is instantiating us. We will store a reference
to the internal time as well as caching various
values specific to this event.
- __repr__(self)
- Present a meaningful representation of the event
- count(self)
- Get the internal-time cycle count at instantiation
- duration(self)
- Get the total internal-time cycle duration
- external(self)
- Get the external time at instantiation
- fraction(self)
- Get the fractional time at instantiation
- getKey(self)
- Event API: get the general event type (self.timetype)
- getTimer(self)
- Get (opaque) pointer to Timer object
This method allows higher-level timer abstractions
to store a pointer to their implementations to allow
higher-level operation.
- setTimer(self, timer)
- Set (opaque) pointer to a Timer object
This method allows higher-level timer abstractions
to store a pointer to their implementations to allow
higher-level operation.
- value(self)
- Get the internal time at instantiation
Data and other attributes inherited from TimeEvent:
- discrete = 1
- type = 'time'
Methods inherited from Event:
- getModifiers(self)
- Retrieve a tuple of the active modifier keys
Format is three Boolean values, (shift, control, alt)
- visited(self, key, value=None)
- Check for or register visitation of the given key
key -- an opaque hashable value, normally the node and
field/event as a tuple.
value -- if provided, sets the current value, otherwise
signals that the current value should be returned
return value: previous key value (possibly None)
Data descriptors inherited from Event:
- __dict__
- dictionary for instance variables (if defined)
- __weakref__
- list of weak references to the object (if defined)
Data and other attributes inherited from Event:
- context = None
- modifiers = (0, 0, 0)
- renderingPass = None
|
class FractionalEvent(TimeEvent) |
| |
Event generated when the InternalTime changes time fraction
FractionalEvents are only generated when the
InternalTime's discreteOnly attribute is false.
This event is generated:
* when InternalTime.poll is called
* when InternalTime.stop is called
Note:
This is the only non-discrete event at the moment
|
| |
- Method resolution order:
- FractionalEvent
- TimeEvent
- Event
- object
Data and other attributes defined here:
- discrete = 0
- timetype = 'fraction'
Methods inherited from TimeEvent:
- __init__(self, internal)
- Initialize the TimeEvent
internal -- pointer to the InternalTime object which
is instantiating us. We will store a reference
to the internal time as well as caching various
values specific to this event.
- __repr__(self)
- Present a meaningful representation of the event
- count(self)
- Get the internal-time cycle count at instantiation
- duration(self)
- Get the total internal-time cycle duration
- external(self)
- Get the external time at instantiation
- fraction(self)
- Get the fractional time at instantiation
- getKey(self)
- Event API: get the general event type (self.timetype)
- getTimer(self)
- Get (opaque) pointer to Timer object
This method allows higher-level timer abstractions
to store a pointer to their implementations to allow
higher-level operation.
- setTimer(self, timer)
- Set (opaque) pointer to a Timer object
This method allows higher-level timer abstractions
to store a pointer to their implementations to allow
higher-level operation.
- value(self)
- Get the internal time at instantiation
Data and other attributes inherited from TimeEvent:
- type = 'time'
Methods inherited from Event:
- getModifiers(self)
- Retrieve a tuple of the active modifier keys
Format is three Boolean values, (shift, control, alt)
- visited(self, key, value=None)
- Check for or register visitation of the given key
key -- an opaque hashable value, normally the node and
field/event as a tuple.
value -- if provided, sets the current value, otherwise
signals that the current value should be returned
return value: previous key value (possibly None)
Data descriptors inherited from Event:
- __dict__
- dictionary for instance variables (if defined)
- __weakref__
- list of weak references to the object (if defined)
Data and other attributes inherited from Event:
- context = None
- modifiers = (0, 0, 0)
- renderingPass = None
|
class PauseEvent(TimeEvent) |
| |
Event generated when the internal time is paused
This event is generated:
* when InternalTime.pause is called
|
| |
- Method resolution order:
- PauseEvent
- TimeEvent
- Event
- object
Data and other attributes defined here:
- timetype = 'pause'
Methods inherited from TimeEvent:
- __init__(self, internal)
- Initialize the TimeEvent
internal -- pointer to the InternalTime object which
is instantiating us. We will store a reference
to the internal time as well as caching various
values specific to this event.
- __repr__(self)
- Present a meaningful representation of the event
- count(self)
- Get the internal-time cycle count at instantiation
- duration(self)
- Get the total internal-time cycle duration
- external(self)
- Get the external time at instantiation
- fraction(self)
- Get the fractional time at instantiation
- getKey(self)
- Event API: get the general event type (self.timetype)
- getTimer(self)
- Get (opaque) pointer to Timer object
This method allows higher-level timer abstractions
to store a pointer to their implementations to allow
higher-level operation.
- setTimer(self, timer)
- Set (opaque) pointer to a Timer object
This method allows higher-level timer abstractions
to store a pointer to their implementations to allow
higher-level operation.
- value(self)
- Get the internal time at instantiation
Data and other attributes inherited from TimeEvent:
- discrete = 1
- type = 'time'
Methods inherited from Event:
- getModifiers(self)
- Retrieve a tuple of the active modifier keys
Format is three Boolean values, (shift, control, alt)
- visited(self, key, value=None)
- Check for or register visitation of the given key
key -- an opaque hashable value, normally the node and
field/event as a tuple.
value -- if provided, sets the current value, otherwise
signals that the current value should be returned
return value: previous key value (possibly None)
Data descriptors inherited from Event:
- __dict__
- dictionary for instance variables (if defined)
- __weakref__
- list of weak references to the object (if defined)
Data and other attributes inherited from Event:
- context = None
- modifiers = (0, 0, 0)
- renderingPass = None
|
class ResumeEvent(TimeEvent) |
| |
Event generated when the internal time is resumed
This event is generated:
* when InternalTime.resume is called
|
| |
- Method resolution order:
- ResumeEvent
- TimeEvent
- Event
- object
Data and other attributes defined here:
- timetype = 'resume'
Methods inherited from TimeEvent:
- __init__(self, internal)
- Initialize the TimeEvent
internal -- pointer to the InternalTime object which
is instantiating us. We will store a reference
to the internal time as well as caching various
values specific to this event.
- __repr__(self)
- Present a meaningful representation of the event
- count(self)
- Get the internal-time cycle count at instantiation
- duration(self)
- Get the total internal-time cycle duration
- external(self)
- Get the external time at instantiation
- fraction(self)
- Get the fractional time at instantiation
- getKey(self)
- Event API: get the general event type (self.timetype)
- getTimer(self)
- Get (opaque) pointer to Timer object
This method allows higher-level timer abstractions
to store a pointer to their implementations to allow
higher-level operation.
- setTimer(self, timer)
- Set (opaque) pointer to a Timer object
This method allows higher-level timer abstractions
to store a pointer to their implementations to allow
higher-level operation.
- value(self)
- Get the internal time at instantiation
Data and other attributes inherited from TimeEvent:
- discrete = 1
- type = 'time'
Methods inherited from Event:
- getModifiers(self)
- Retrieve a tuple of the active modifier keys
Format is three Boolean values, (shift, control, alt)
- visited(self, key, value=None)
- Check for or register visitation of the given key
key -- an opaque hashable value, normally the node and
field/event as a tuple.
value -- if provided, sets the current value, otherwise
signals that the current value should be returned
return value: previous key value (possibly None)
Data descriptors inherited from Event:
- __dict__
- dictionary for instance variables (if defined)
- __weakref__
- list of weak references to the object (if defined)
Data and other attributes inherited from Event:
- context = None
- modifiers = (0, 0, 0)
- renderingPass = None
|
class StartEvent(TimeEvent) |
| |
Event generated when the internal time is started
This event is generated:
when InternalTime.start is called
|
| |
- Method resolution order:
- StartEvent
- TimeEvent
- Event
- object
Data and other attributes defined here:
- timetype = 'start'
Methods inherited from TimeEvent:
- __init__(self, internal)
- Initialize the TimeEvent
internal -- pointer to the InternalTime object which
is instantiating us. We will store a reference
to the internal time as well as caching various
values specific to this event.
- __repr__(self)
- Present a meaningful representation of the event
- count(self)
- Get the internal-time cycle count at instantiation
- duration(self)
- Get the total internal-time cycle duration
- external(self)
- Get the external time at instantiation
- fraction(self)
- Get the fractional time at instantiation
- getKey(self)
- Event API: get the general event type (self.timetype)
- getTimer(self)
- Get (opaque) pointer to Timer object
This method allows higher-level timer abstractions
to store a pointer to their implementations to allow
higher-level operation.
- setTimer(self, timer)
- Set (opaque) pointer to a Timer object
This method allows higher-level timer abstractions
to store a pointer to their implementations to allow
higher-level operation.
- value(self)
- Get the internal time at instantiation
Data and other attributes inherited from TimeEvent:
- discrete = 1
- type = 'time'
Methods inherited from Event:
- getModifiers(self)
- Retrieve a tuple of the active modifier keys
Format is three Boolean values, (shift, control, alt)
- visited(self, key, value=None)
- Check for or register visitation of the given key
key -- an opaque hashable value, normally the node and
field/event as a tuple.
value -- if provided, sets the current value, otherwise
signals that the current value should be returned
return value: previous key value (possibly None)
Data descriptors inherited from Event:
- __dict__
- dictionary for instance variables (if defined)
- __weakref__
- list of weak references to the object (if defined)
Data and other attributes inherited from Event:
- context = None
- modifiers = (0, 0, 0)
- renderingPass = None
|
class StopEvent(TimeEvent) |
| |
Event generated when the internal time stops
This event is generated:
* when InternalTime.stop is called
* when a non-repeating InternalTime reaches
the end of the cycle (natural finish)
* when a repeating, but count-limited
InternalTime reaches the end of its last
cycle.
If the InternalTime generates fractional events,
then a fractional event will be generated at the
same time as the StopEvent
|
| |
- Method resolution order:
- StopEvent
- TimeEvent
- Event
- object
Data and other attributes defined here:
- timetype = 'stop'
Methods inherited from TimeEvent:
- __init__(self, internal)
- Initialize the TimeEvent
internal -- pointer to the InternalTime object which
is instantiating us. We will store a reference
to the internal time as well as caching various
values specific to this event.
- __repr__(self)
- Present a meaningful representation of the event
- count(self)
- Get the internal-time cycle count at instantiation
- duration(self)
- Get the total internal-time cycle duration
- external(self)
- Get the external time at instantiation
- fraction(self)
- Get the fractional time at instantiation
- getKey(self)
- Event API: get the general event type (self.timetype)
- getTimer(self)
- Get (opaque) pointer to Timer object
This method allows higher-level timer abstractions
to store a pointer to their implementations to allow
higher-level operation.
- setTimer(self, timer)
- Set (opaque) pointer to a Timer object
This method allows higher-level timer abstractions
to store a pointer to their implementations to allow
higher-level operation.
- value(self)
- Get the internal time at instantiation
Data and other attributes inherited from TimeEvent:
- discrete = 1
- type = 'time'
Methods inherited from Event:
- getModifiers(self)
- Retrieve a tuple of the active modifier keys
Format is three Boolean values, (shift, control, alt)
- visited(self, key, value=None)
- Check for or register visitation of the given key
key -- an opaque hashable value, normally the node and
field/event as a tuple.
value -- if provided, sets the current value, otherwise
signals that the current value should be returned
return value: previous key value (possibly None)
Data descriptors inherited from Event:
- __dict__
- dictionary for instance variables (if defined)
- __weakref__
- list of weak references to the object (if defined)
Data and other attributes inherited from Event:
- context = None
- modifiers = (0, 0, 0)
- renderingPass = None
|
class TimeEvent(Event) |
| |
Base class for all time-related events
Attributes:
discrete -- whether or not this is a discrete-time
event, that is whether it a non-fractional event,
defaults to true
type -- static event type, "time"
timetype -- a string specifying the time-event sub-type
see subclasses in this module for valid specifiers
|
| |
- Method resolution order:
- TimeEvent
- Event
- object
Methods defined here:
- __init__(self, internal)
- Initialize the TimeEvent
internal -- pointer to the InternalTime object which
is instantiating us. We will store a reference
to the internal time as well as caching various
values specific to this event.
- __repr__(self)
- Present a meaningful representation of the event
- count(self)
- Get the internal-time cycle count at instantiation
- duration(self)
- Get the total internal-time cycle duration
- external(self)
- Get the external time at instantiation
- fraction(self)
- Get the fractional time at instantiation
- getKey(self)
- Event API: get the general event type (self.timetype)
- getTimer(self)
- Get (opaque) pointer to Timer object
This method allows higher-level timer abstractions
to store a pointer to their implementations to allow
higher-level operation.
- setTimer(self, timer)
- Set (opaque) pointer to a Timer object
This method allows higher-level timer abstractions
to store a pointer to their implementations to allow
higher-level operation.
- value(self)
- Get the internal time at instantiation
Data and other attributes defined here:
- discrete = 1
- timetype = ''
- type = 'time'
Methods inherited from Event:
- getModifiers(self)
- Retrieve a tuple of the active modifier keys
Format is three Boolean values, (shift, control, alt)
- visited(self, key, value=None)
- Check for or register visitation of the given key
key -- an opaque hashable value, normally the node and
field/event as a tuple.
value -- if provided, sets the current value, otherwise
signals that the current value should be returned
return value: previous key value (possibly None)
Data descriptors inherited from Event:
- __dict__
- dictionary for instance variables (if defined)
- __weakref__
- list of weak references to the object (if defined)
Data and other attributes inherited from Event:
- context = None
- modifiers = (0, 0, 0)
- renderingPass = None
| |