Source code for direct.distributed.DistributedObjectOV

from direct.directnotify.DirectNotifyGlobal import directNotify
from direct.distributed.DistributedObjectBase import DistributedObjectBase

#from PyDatagram import PyDatagram
#from PyDatagramIterator import PyDatagramIterator

# Values for DistributedObjectOV.activeState
# these should match DistributedObject.ES*

ESNew          = 1
ESDeleted      = 2
ESDisabling    = 3
ESDisabled     = 4  # values here and lower are considered "disabled"
ESGenerating   = 5  # values here and greater are considered "generated"
ESGenerated    = 6

[docs]class DistributedObjectOV(DistributedObjectBase): """ Implementation of the 'owner view' (OV) of a distributed object; """ notify = directNotify.newCategory("DistributedObjectOV")
[docs] def __init__(self, cr): assert self.notify.debugStateCall(self) try: self.DistributedObjectOV_initialized except: self.DistributedObjectOV_initialized = 1 DistributedObjectBase.__init__(self, cr) # Keep track of our state as a distributed object. This # is only trustworthy if the inheriting class properly # calls up the chain for disable() and generate(). self.activeState = ESNew
if __debug__:
[docs] def status(self, indent=0): """ print out "doId(parentId, zoneId) className" and conditionally show generated, disabled """ spaces = ' ' * (indent + 2) try: print("%s%s:" % (' ' * indent, self.__class__.__name__)) flags = [] if self.activeState == ESGenerated: flags.append("generated") if self.activeState < ESGenerating: flags.append("disabled") flagStr = "" if len(flags): flagStr = " (%s)" % (" ".join(flags)) print("%sfrom DistributedObjectOV doId:%s, parent:%s, zone:%s%s" % ( spaces, self.doId, self.parentId, self.zoneId, flagStr)) except Exception as e: print("%serror printing status %s" % (spaces, e))
[docs] def getDelayDeleteCount(self): # OV objects cannot be delayDeleted return 0
[docs] def deleteOrDelay(self): self.disableAnnounceAndDelete()
[docs] def disableAnnounceAndDelete(self): self.disableAndAnnounce() self.delete()
[docs] def disableAndAnnounce(self): # We must send the disable announce message *before* we # actually disable the object. That way, the various cleanup # tasks can run first and take care of restoring the object to # a normal, nondisabled state; and *then* the disable function # can properly disable it (for instance, by parenting it to # hidden). if self.activeState != ESDisabled: self.activeState = ESDisabling messenger.send(self.uniqueName("disable")) self.disable()
[docs] def announceGenerate(self): """ Sends a message to the world after the object has been generated and all of its required fields filled in. """ assert self.notify.debug('announceGenerate(): %s' % (self.doId))
[docs] def disable(self): """ Inheritors should redefine this to take appropriate action on disable """ assert self.notify.debug('disable(): %s' % (self.doId)) if self.activeState != ESDisabled: self.activeState = ESDisabled
[docs] def isDisabled(self): """ Returns true if the object has been disabled and/or deleted, or if it is brand new and hasn't yet been generated. """ return (self.activeState < ESGenerating)
[docs] def isGenerated(self): """ Returns true if the object has been fully generated by now, and not yet disabled. """ assert self.notify.debugStateCall(self) return (self.activeState == ESGenerated)
[docs] def delete(self): """ Inheritors should redefine this to take appropriate action on delete """ assert self.notify.debug('delete(): %s' % (self.doId)) try: self.DistributedObjectOV_deleted except: self.DistributedObjectOV_deleted = 1 = None self.dclass = None
[docs] def generate(self): """ Inheritors should redefine this to take appropriate action on generate """ assert self.notify.debugStateCall(self) self.activeState = ESGenerating
# this has already been set at this point, self.parentId, self.zoneId)
[docs] def generateInit(self): """ This method is called when the DistributedObjectOV is first introduced to the world... Not when it is pulled from the cache. """ self.activeState = ESGenerating
[docs] def getDoId(self): """ Return the distributed object id """ return self.doId
[docs] def postGenerateMessage(self): if self.activeState != ESGenerated: self.activeState = ESGenerated messenger.send(self.uniqueName("generate"), [self])
[docs] def updateRequiredFields(self, dclass, di): dclass.receiveUpdateBroadcastRequired(self, di) self.announceGenerate() self.postGenerateMessage()
[docs] def updateAllRequiredFields(self, dclass, di): dclass.receiveUpdateAllRequired(self, di) self.announceGenerate() self.postGenerateMessage()
[docs] def updateRequiredOtherFields(self, dclass, di): # First, update the required fields dclass.receiveUpdateBroadcastRequiredOwner(self, di) # Announce generate after updating all the required fields, # but before we update the non-required fields. self.announceGenerate() self.postGenerateMessage() dclass.receiveUpdateOther(self, di)
[docs] def getCacheable(self): return False
[docs] def sendUpdate(self, fieldName, args = [], sendToId = None): if dg = self.dclass.clientFormatUpdate( fieldName, sendToId or self.doId, args) else: self.notify.warning("sendUpdate failed, because is not set")
[docs] def taskName(self, taskString): return ('%s-%s-OV' % (taskString, self.getDoId()))
[docs] def uniqueName(self, idString): return ('%s-%s-OV' % (idString, self.getDoId()))