# encoding: utf-8
# module vtkmodules.vtkInteractionWidgets
# from C:\Users\xukai\Downloads\发票2\venv\Lib\site-packages\vtkmodules\vtkInteractionWidgets.cp311-win_amd64.pyd
# by generator 1.147
# no doc

# imports
import vtkmodules.vtkCommonCore as __vtkmodules_vtkCommonCore
import vtkmodules.vtkCommonExecutionModel as __vtkmodules_vtkCommonExecutionModel
import vtkmodules.vtkFiltersSources as __vtkmodules_vtkFiltersSources
import vtkmodules.vtkRenderingContext2D as __vtkmodules_vtkRenderingContext2D
import vtkmodules.vtkRenderingCore as __vtkmodules_vtkRenderingCore


from .vtkHoverWidget import vtkHoverWidget

class vtkBalloonWidget(vtkHoverWidget):
    """
    vtkBalloonWidget - popup text balloons above instance of vtkProp when
    hovering occurs
    
    Superclass: vtkHoverWidget
    
    The vtkBalloonWidget is used to popup text and/or an image when the
    mouse hovers over an instance of vtkProp. The widget keeps track of
    (vtkProp,vtkBalloon) pairs (where the internal vtkBalloon class is
    defined by a pair of vtkStdString and vtkImageData), and when the
    mouse stops moving for a user-specified period of time over the
    vtkProp, then the vtkBalloon is drawn nearby the vtkProp. Note that
    an instance of vtkBalloonRepresentation is used to draw the balloon.
    
    To use this widget, specify an instance of vtkBalloonWidget and a
    representation (e.g., vtkBalloonRepresentation). Then list all
    instances of vtkProp, a text string, and/or an instance of
    vtkImageData to be associated with each vtkProp. (Note that you can
    specify both text and an image, or just one or the other.) You may
    also wish to specify the hover delay (i.e., set in the superclass
    vtkHoverWidget).
    
    @par Event Bindings: By default, the widget observes the following
    VTK events (i.e., it watches the vtkRenderWindowInteractor for these
    events):
    
    
      MouseMoveEvent - occurs when mouse is moved in render window.
      TimerEvent - occurs when the time between events (e.g., mouse move)
                   is greater than TimerDuration.
      KeyPressEvent - when the "Enter" key is pressed after the balloon
    appears,
                      a callback is activated (e.g.,
    WidgetActivateEvent). 
    
    @par Event Bindings: Note that the event bindings described above can
    be changed using this class's vtkWidgetEventTranslator. This class
    translates VTK events into the vtkBalloonWidget's widget events:
    
    
      vtkWidgetEvent::Move -- start the timer
      vtkWidgetEvent::TimedOut -- when hovering occurs,
      vtkWidgetEvent::SelectAction -- activate any callbacks associated
                                      with the balloon. 
    
    @par Event Bindings: This widget invokes the following VTK events on
    itself (which observers can listen for):
    
    
      vtkCommand::TimerEvent (when hovering is determined to occur)
      vtkCommand::EndInteractionEvent (after a hover has occurred and the
                                       mouse begins moving again).
      vtkCommand::WidgetActivateEvent (when the balloon is selected with
    a
                                       keypress). 
    
    @sa
    vtkAbstractWidget
    """
    def AddBalloon(self, prop, p_str, img): # real signature unknown; restored from __doc__
        """
        AddBalloon(self, prop:vtkProp, str:str, img:vtkImageData) -> None
        C++: void AddBalloon(vtkProp *prop, const char *str,
            vtkImageData *img)
        AddBalloon(self, prop:vtkProp, str:str) -> None
        C++: void AddBalloon(vtkProp *prop, const char *str)
        """
        pass

    def CreateDefaultRepresentation(self): # real signature unknown; restored from __doc__
        """
        CreateDefaultRepresentation(self) -> None
        C++: void CreateDefaultRepresentation() override;
        
        Create the default widget representation if one is not set.
        """
        pass

    def GetBalloonImage(self, prop): # real signature unknown; restored from __doc__
        """
        GetBalloonImage(self, prop:vtkProp) -> vtkImageData
        C++: vtkImageData *GetBalloonImage(vtkProp *prop)
        """
        pass

    def GetBalloonRepresentation(self): # real signature unknown; restored from __doc__
        """
        GetBalloonRepresentation(self) -> vtkBalloonRepresentation
        C++: vtkBalloonRepresentation *GetBalloonRepresentation()
        
        Return the representation as a vtkBalloonRepresentation.
        """
        return vtkBalloonRepresentation

    def GetBalloonString(self, prop): # real signature unknown; restored from __doc__
        """
        GetBalloonString(self, prop:vtkProp) -> str
        C++: const char *GetBalloonString(vtkProp *prop)
        
        Methods to retrieve the information associated with each vtkProp
        (i.e., the information that makes up each balloon). A nullptr
        will be returned if the vtkProp does not exist, or if a string or
        image have not been associated with the specified vtkProp.
        """
        return ""

    def GetCurrentProp(self): # real signature unknown; restored from __doc__
        """
        GetCurrentProp(self) -> vtkProp
        C++: virtual vtkProp *GetCurrentProp()
        
        Return the current vtkProp that is being hovered over. Note that
        the value may be nullptr (if hovering over nothing or the mouse
        is moving).
        """
        pass

    def GetNumberOfGenerationsFromBase(self, type): # real signature unknown; restored from __doc__
        """
        GetNumberOfGenerationsFromBase(self, type:str) -> int
        C++: vtkIdType GetNumberOfGenerationsFromBase(const char *type)
            override;
        
        Given the name of a base class of this class type, return the
        distance of inheritance between this class type and the named
        class (how many generations of inheritance are there between this
        class and the named class). If the named class is not in this
        class's inheritance tree, return a negative value. Valid
        responses will always be nonnegative. This method works in
        combination with vtkTypeMacro found in vtkSetGet.h.
        """
        return 0

    def GetNumberOfGenerationsFromBaseType(self, type): # real signature unknown; restored from __doc__
        """
        GetNumberOfGenerationsFromBaseType(type:str) -> int
        C++: static vtkIdType GetNumberOfGenerationsFromBaseType(
            const char *type)
        
        Given a the name of a base class of this class type, return the
        distance of inheritance between this class type and the named
        class (how many generations of inheritance are there between this
        class and the named class). If the named class is not in this
        class's inheritance tree, return a negative value. Valid
        responses will always be nonnegative. This method works in
        combination with vtkTypeMacro found in vtkSetGet.h.
        """
        return 0

    def GetPicker(self): # real signature unknown; restored from __doc__
        """
        GetPicker(self) -> vtkAbstractPropPicker
        C++: virtual vtkAbstractPropPicker *GetPicker()
        """
        pass

    def IsA(self, type): # real signature unknown; restored from __doc__
        """
        IsA(self, type:str) -> int
        C++: vtkTypeBool IsA(const char *type) override;
        
        Return 1 if this class is the same type of (or a subclass of) the
        named class. Returns 0 otherwise. This method works in
        combination with vtkTypeMacro found in vtkSetGet.h.
        """
        return 0

    def IsTypeOf(self, type): # real signature unknown; restored from __doc__
        """
        IsTypeOf(type:str) -> int
        C++: static vtkTypeBool IsTypeOf(const char *type)
        
        Return 1 if this class type is the same type of (or a subclass
        of) the named class. Returns 0 otherwise. This method works in
        combination with vtkTypeMacro found in vtkSetGet.h.
        """
        return 0

    def NewInstance(self): # real signature unknown; restored from __doc__
        """
        NewInstance(self) -> vtkBalloonWidget
        C++: vtkBalloonWidget *NewInstance()
        """
        return vtkBalloonWidget

    def RegisterPickers(self): # real signature unknown; restored from __doc__
        """
        RegisterPickers(self) -> None
        C++: void RegisterPickers() override;
        
        Register internal Pickers in the Picking Manager. Must be
        reimplemented by concrete widgets to register their pickers.
        """
        pass

    def RemoveBalloon(self, prop): # real signature unknown; restored from __doc__
        """
        RemoveBalloon(self, prop:vtkProp) -> None
        C++: void RemoveBalloon(vtkProp *prop)
        """
        pass

    def SafeDownCast(self, o): # real signature unknown; restored from __doc__
        """
        SafeDownCast(o:vtkObjectBase) -> vtkBalloonWidget
        C++: static vtkBalloonWidget *SafeDownCast(vtkObjectBase *o)
        """
        return vtkBalloonWidget

    def SetEnabled(self, __a): # real signature unknown; restored from __doc__
        """
        SetEnabled(self, __a:int) -> None
        C++: void SetEnabled(int) override;
        
        The method for activating and deactivating this widget. This
        method must be overridden because it performs special
        timer-related operations.
        """
        pass

    def SetPicker(self, __a): # real signature unknown; restored from __doc__
        """
        SetPicker(self, __a:vtkAbstractPropPicker) -> None
        C++: void SetPicker(vtkAbstractPropPicker *)
        
        Set/Get the object used to perform pick operations. Since the
        vtkBalloonWidget operates on vtkProps, the picker must be a
        subclass of vtkAbstractPropPicker. (Note: if not specified, an
        instance of vtkPropPicker is used.)
        """
        pass

    def SetRepresentation(self, r): # real signature unknown; restored from __doc__
        """
        SetRepresentation(self, r:vtkBalloonRepresentation) -> None
        C++: void SetRepresentation(vtkBalloonRepresentation *r)
        
        Specify an instance of vtkWidgetRepresentation used to represent
        this widget in the scene. Note that the representation is a
        subclass of vtkProp so it can be added to the renderer
        independent of the widget.
        """
        pass

    def UpdateBalloonImage(self, prop, image): # real signature unknown; restored from __doc__
        """
        UpdateBalloonImage(self, prop:vtkProp, image:vtkImageData) -> None
        C++: void UpdateBalloonImage(vtkProp *prop, vtkImageData *image)
        """
        pass

    def UpdateBalloonString(self, prop, p_str): # real signature unknown; restored from __doc__
        """
        UpdateBalloonString(self, prop:vtkProp, str:str) -> None
        C++: void UpdateBalloonString(vtkProp *prop, const char *str)
        
        Update the balloon string or image. If the specified prop does
        not exist, then nothing is added not changed.
        """
        pass

    def __delattr__(self, *args, **kwargs): # real signature unknown
        """ Implement delattr(self, name). """
        pass

    def __getattribute__(self, *args, **kwargs): # real signature unknown
        """ Return getattr(self, name). """
        pass

    def __init__(self, *args, **kwargs): # real signature unknown
        pass

    @staticmethod # known case of __new__
    def __new__(*args, **kwargs): # real signature unknown
        """ Create and return a new object.  See help(type) for accurate signature. """
        pass

    def __repr__(self, *args, **kwargs): # real signature unknown
        """ Return repr(self). """
        pass

    def __setattr__(self, *args, **kwargs): # real signature unknown
        """ Implement setattr(self, name, value). """
        pass

    def __str__(self, *args, **kwargs): # real signature unknown
        """ Return str(self). """
        pass

    __this__ = property(lambda self: object(), lambda self, v: None, lambda self: None)  # default
    """Pointer to the C++ object."""


    __dict__ = None # (!) real value is 'mappingproxy({\'__vtkname__\': \'vtkBalloonWidget\', \'IsTypeOf\': <method \'IsTypeOf\' of \'vtkmodules.vtkInteractionWidgets.vtkBalloonWidget\' objects>, \'IsA\': <method \'IsA\' of \'vtkmodules.vtkInteractionWidgets.vtkBalloonWidget\' objects>, \'SafeDownCast\': <method \'SafeDownCast\' of \'vtkmodules.vtkInteractionWidgets.vtkBalloonWidget\' objects>, \'NewInstance\': <method \'NewInstance\' of \'vtkmodules.vtkInteractionWidgets.vtkBalloonWidget\' objects>, \'GetNumberOfGenerationsFromBaseType\': <method \'GetNumberOfGenerationsFromBaseType\' of \'vtkmodules.vtkInteractionWidgets.vtkBalloonWidget\' objects>, \'GetNumberOfGenerationsFromBase\': <method \'GetNumberOfGenerationsFromBase\' of \'vtkmodules.vtkInteractionWidgets.vtkBalloonWidget\' objects>, \'SetEnabled\': <method \'SetEnabled\' of \'vtkmodules.vtkInteractionWidgets.vtkBalloonWidget\' objects>, \'SetRepresentation\': <method \'SetRepresentation\' of \'vtkmodules.vtkInteractionWidgets.vtkBalloonWidget\' objects>, \'GetBalloonRepresentation\': <method \'GetBalloonRepresentation\' of \'vtkmodules.vtkInteractionWidgets.vtkBalloonWidget\' objects>, \'CreateDefaultRepresentation\': <method \'CreateDefaultRepresentation\' of \'vtkmodules.vtkInteractionWidgets.vtkBalloonWidget\' objects>, \'AddBalloon\': <method \'AddBalloon\' of \'vtkmodules.vtkInteractionWidgets.vtkBalloonWidget\' objects>, \'RemoveBalloon\': <method \'RemoveBalloon\' of \'vtkmodules.vtkInteractionWidgets.vtkBalloonWidget\' objects>, \'GetBalloonString\': <method \'GetBalloonString\' of \'vtkmodules.vtkInteractionWidgets.vtkBalloonWidget\' objects>, \'GetBalloonImage\': <method \'GetBalloonImage\' of \'vtkmodules.vtkInteractionWidgets.vtkBalloonWidget\' objects>, \'UpdateBalloonString\': <method \'UpdateBalloonString\' of \'vtkmodules.vtkInteractionWidgets.vtkBalloonWidget\' objects>, \'UpdateBalloonImage\': <method \'UpdateBalloonImage\' of \'vtkmodules.vtkInteractionWidgets.vtkBalloonWidget\' objects>, \'GetCurrentProp\': <method \'GetCurrentProp\' of \'vtkmodules.vtkInteractionWidgets.vtkBalloonWidget\' objects>, \'SetPicker\': <method \'SetPicker\' of \'vtkmodules.vtkInteractionWidgets.vtkBalloonWidget\' objects>, \'GetPicker\': <method \'GetPicker\' of \'vtkmodules.vtkInteractionWidgets.vtkBalloonWidget\' objects>, \'RegisterPickers\': <method \'RegisterPickers\' of \'vtkmodules.vtkInteractionWidgets.vtkBalloonWidget\' objects>, \'__new__\': <built-in method __new__ of type object at 0x00007FF81D636C90>, \'__repr__\': <slot wrapper \'__repr__\' of \'vtkmodules.vtkInteractionWidgets.vtkBalloonWidget\' objects>, \'__str__\': <slot wrapper \'__str__\' of \'vtkmodules.vtkInteractionWidgets.vtkBalloonWidget\' objects>, \'__getattribute__\': <slot wrapper \'__getattribute__\' of \'vtkmodules.vtkInteractionWidgets.vtkBalloonWidget\' objects>, \'__setattr__\': <slot wrapper \'__setattr__\' of \'vtkmodules.vtkInteractionWidgets.vtkBalloonWidget\' objects>, \'__delattr__\': <slot wrapper \'__delattr__\' of \'vtkmodules.vtkInteractionWidgets.vtkBalloonWidget\' objects>, \'__dict__\': <attribute \'__dict__\' of \'vtkmodules.vtkInteractionWidgets.vtkBalloonWidget\' objects>, \'__this__\': <attribute \'__this__\' of \'vtkmodules.vtkInteractionWidgets.vtkBalloonWidget\' objects>, \'__doc__\': \'vtkBalloonWidget - popup text balloons above instance of vtkProp when\\nhovering occurs\\n\\nSuperclass: vtkHoverWidget\\n\\nThe vtkBalloonWidget is used to popup text and/or an image when the\\nmouse hovers over an instance of vtkProp. The widget keeps track of\\n(vtkProp,vtkBalloon) pairs (where the internal vtkBalloon class is\\ndefined by a pair of vtkStdString and vtkImageData), and when the\\nmouse stops moving for a user-specified period of time over the\\nvtkProp, then the vtkBalloon is drawn nearby the vtkProp. Note that\\nan instance of vtkBalloonRepresentation is used to draw the balloon.\\n\\nTo use this widget, specify an instance of vtkBalloonWidget and a\\nrepresentation (e.g., vtkBalloonRepresentation). Then list all\\ninstances of vtkProp, a text string, and/or an instance of\\nvtkImageData to be associated with each vtkProp. (Note that you can\\nspecify both text and an image, or just one or the other.) You may\\nalso wish to specify the hover delay (i.e., set in the superclass\\nvtkHoverWidget).\\n\\n@par Event Bindings: By default, the widget observes the following\\nVTK events (i.e., it watches the vtkRenderWindowInteractor for these\\nevents):\\n\\n\\n  MouseMoveEvent - occurs when mouse is moved in render window.\\n  TimerEvent - occurs when the time between events (e.g., mouse move)\\n               is greater than TimerDuration.\\n  KeyPressEvent - when the "Enter" key is pressed after the balloon\\nappears,\\n                  a callback is activated (e.g.,\\nWidgetActivateEvent). \\n\\n@par Event Bindings: Note that the event bindings described above can\\nbe changed using this class\\\'s vtkWidgetEventTranslator. This class\\ntranslates VTK events into the vtkBalloonWidget\\\'s widget events:\\n\\n\\n  vtkWidgetEvent::Move -- start the timer\\n  vtkWidgetEvent::TimedOut -- when hovering occurs,\\n  vtkWidgetEvent::SelectAction -- activate any callbacks associated\\n                                  with the balloon. \\n\\n@par Event Bindings: This widget invokes the following VTK events on\\nitself (which observers can listen for):\\n\\n\\n  vtkCommand::TimerEvent (when hovering is determined to occur)\\n  vtkCommand::EndInteractionEvent (after a hover has occurred and the\\n                                   mouse begins moving again).\\n  vtkCommand::WidgetActivateEvent (when the balloon is selected with\\na\\n                                   keypress). \\n\\n@sa\\nvtkAbstractWidget\\n\\n\'})'
    __vtkname__ = 'vtkBalloonWidget'


