# 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 .vtkPolyDataSourceWidget import vtkPolyDataSourceWidget class vtkImplicitPlaneWidget(vtkPolyDataSourceWidget): """ vtkImplicitPlaneWidget - 3D widget for manipulating an infinite plane Superclass: vtkPolyDataSourceWidget This 3D widget defines an infinite plane that can be interactively placed in a scene. The widget is represented by a plane with a normal vector; the plane is contained by a bounding box, and where the plane intersects the bounding box the edges are shown (possibly tubed). The normal can be selected and moved to rotate the plane; the plane itself can be selected and translated in various directions. As the plane is moved, the implicit plane function and polygon (representing the plane cut against the bounding box) is updated. To use this object, just invoke SetInteractor() with the argument of the method a vtkRenderWindowInteractor. You may also wish to invoke "PlaceWidget()" to initially position the widget. If the "i" key (for "interactor") is pressed, the vtkImplicitPlaneWidget will appear. (See superclass documentation for information about changing this behavior.) If you select the normal vector, the plane can be arbitrarily rotated. The plane can be translated along the normal by selecting the plane and moving it. The plane (the plane origin) can also be arbitrary moved by selecting the plane with the middle mouse button. The right mouse button can be used to uniformly scale the bounding box (moving "up" the box scales larger; moving "down" the box scales smaller). Events that occur outside of the widget (i.e., no part of the widget is picked) are propagated to any other registered obsevers (such as the interaction style). Turn off the widget by pressing the "i" key again (or invoke the Off() method). The vtkImplicitPlaneWidget has several methods that can be used in conjunction with other VTK objects. The GetPolyData() method can be used to get a polygonal representation (the single polygon clipped by the bounding box). Typical usage of the widget is to make use of the StartInteractionEvent, InteractionEvent, and EndInteractionEvent events. The InteractionEvent is called on mouse motion; the other two events are called on button down and button up (either left or right button). (Note: there is also a PlaceWidgetEvent that is invoked when the widget is placed with PlaceWidget().) Some additional features of this class include the ability to control the properties of the widget. You do this by setting property values on the normal vector (selected and unselected properties); the plane (selected and unselected properties); the outline (selected and unselected properties); and the edges. The edges may also be tubed or not. @sa vtk3DWidget vtkBoxWidget vtkPlaneWidget vtkLineWidget vtkPointWidget vtkSphereWidget vtkImagePlaneWidget """ def DrawPlaneOff(self): # real signature unknown; restored from __doc__ """ DrawPlaneOff(self) -> None C++: virtual void DrawPlaneOff() """ pass def DrawPlaneOn(self): # real signature unknown; restored from __doc__ """ DrawPlaneOn(self) -> None C++: virtual void DrawPlaneOn() """ pass def GetDiagonalRatio(self): # real signature unknown; restored from __doc__ """ GetDiagonalRatio(self) -> float C++: virtual double GetDiagonalRatio() """ return 0.0 def GetDiagonalRatioMaxValue(self): # real signature unknown; restored from __doc__ """ GetDiagonalRatioMaxValue(self) -> float C++: virtual double GetDiagonalRatioMaxValue() """ return 0.0 def GetDiagonalRatioMinValue(self): # real signature unknown; restored from __doc__ """ GetDiagonalRatioMinValue(self) -> float C++: virtual double GetDiagonalRatioMinValue() """ return 0.0 def GetDrawPlane(self): # real signature unknown; restored from __doc__ """ GetDrawPlane(self) -> int C++: virtual vtkTypeBool GetDrawPlane() """ return 0 def GetEdgesProperty(self): # real signature unknown; restored from __doc__ """ GetEdgesProperty(self) -> vtkProperty C++: virtual vtkProperty *GetEdgesProperty() Get the property of the intersection edges. (This property also applies to the edges when tubed.) """ pass def GetNormal(self): # real signature unknown; restored from __doc__ """ GetNormal(self) -> (float, float, float) C++: double *GetNormal() GetNormal(self, xyz:[float, float, float]) -> None C++: void GetNormal(double xyz[3]) """ pass def GetNormalProperty(self): # real signature unknown; restored from __doc__ """ GetNormalProperty(self) -> vtkProperty C++: virtual vtkProperty *GetNormalProperty() Get the properties on the normal (line and cone). """ pass def GetNormalToXAxis(self): # real signature unknown; restored from __doc__ """ GetNormalToXAxis(self) -> int C++: virtual vtkTypeBool GetNormalToXAxis() """ return 0 def GetNormalToYAxis(self): # real signature unknown; restored from __doc__ """ GetNormalToYAxis(self) -> int C++: virtual vtkTypeBool GetNormalToYAxis() """ return 0 def GetNormalToZAxis(self): # real signature unknown; restored from __doc__ """ GetNormalToZAxis(self) -> int C++: virtual vtkTypeBool GetNormalToZAxis() """ return 0 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 GetOrigin(self): # real signature unknown; restored from __doc__ """ GetOrigin(self) -> (float, float, float) C++: double *GetOrigin() GetOrigin(self, xyz:[float, float, float]) -> None C++: void GetOrigin(double xyz[3]) """ pass def GetOriginTranslation(self): # real signature unknown; restored from __doc__ """ GetOriginTranslation(self) -> int C++: virtual vtkTypeBool GetOriginTranslation() """ return 0 def GetOutlineProperty(self): # real signature unknown; restored from __doc__ """ GetOutlineProperty(self) -> vtkProperty C++: virtual vtkProperty *GetOutlineProperty() Get the property of the outline. """ pass def GetOutlineTranslation(self): # real signature unknown; restored from __doc__ """ GetOutlineTranslation(self) -> int C++: virtual vtkTypeBool GetOutlineTranslation() """ return 0 def GetOutsideBounds(self): # real signature unknown; restored from __doc__ """ GetOutsideBounds(self) -> int C++: virtual vtkTypeBool GetOutsideBounds() """ return 0 def GetPlane(self, plane): # real signature unknown; restored from __doc__ """ GetPlane(self, plane:vtkPlane) -> None C++: void GetPlane(vtkPlane *plane) Get the implicit function for the plane. The user must provide the instance of the class vtkPlane. Note that vtkPlane is a subclass of vtkImplicitFunction, meaning that it can be used by a variety of filters to perform clipping, cutting, and selection of data. """ pass def GetPlaneProperty(self): # real signature unknown; restored from __doc__ """ GetPlaneProperty(self) -> vtkProperty C++: virtual vtkProperty *GetPlaneProperty() Get the plane properties. The properties of the plane when selected and unselected can be manipulated. """ pass def GetPolyData(self, pd): # real signature unknown; restored from __doc__ """ GetPolyData(self, pd:vtkPolyData) -> None C++: void GetPolyData(vtkPolyData *pd) Grab the polydata that defines the plane. The polydata contains a single polygon that is clipped by the bounding box. """ pass def GetPolyDataAlgorithm(self): # real signature unknown; restored from __doc__ """ GetPolyDataAlgorithm(self) -> vtkPolyDataAlgorithm C++: vtkPolyDataAlgorithm *GetPolyDataAlgorithm() override; Satisfies superclass API. This returns a pointer to the underlying PolyData (which represents the plane). """ pass def GetScaleEnabled(self): # real signature unknown; restored from __doc__ """ GetScaleEnabled(self) -> int C++: virtual vtkTypeBool GetScaleEnabled() """ return 0 def GetSelectedNormalProperty(self): # real signature unknown; restored from __doc__ """ GetSelectedNormalProperty(self) -> vtkProperty C++: virtual vtkProperty *GetSelectedNormalProperty() """ pass def GetSelectedOutlineProperty(self): # real signature unknown; restored from __doc__ """ GetSelectedOutlineProperty(self) -> vtkProperty C++: virtual vtkProperty *GetSelectedOutlineProperty() """ pass def GetSelectedPlaneProperty(self): # real signature unknown; restored from __doc__ """ GetSelectedPlaneProperty(self) -> vtkProperty C++: virtual vtkProperty *GetSelectedPlaneProperty() """ pass def GetTubing(self): # real signature unknown; restored from __doc__ """ GetTubing(self) -> int C++: virtual vtkTypeBool GetTubing() """ return 0 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) -> vtkImplicitPlaneWidget C++: vtkImplicitPlaneWidget *NewInstance() """ return vtkImplicitPlaneWidget def NormalToXAxisOff(self): # real signature unknown; restored from __doc__ """ NormalToXAxisOff(self) -> None C++: virtual void NormalToXAxisOff() """ pass def NormalToXAxisOn(self): # real signature unknown; restored from __doc__ """ NormalToXAxisOn(self) -> None C++: virtual void NormalToXAxisOn() """ pass def NormalToYAxisOff(self): # real signature unknown; restored from __doc__ """ NormalToYAxisOff(self) -> None C++: virtual void NormalToYAxisOff() """ pass def NormalToYAxisOn(self): # real signature unknown; restored from __doc__ """ NormalToYAxisOn(self) -> None C++: virtual void NormalToYAxisOn() """ pass def NormalToZAxisOff(self): # real signature unknown; restored from __doc__ """ NormalToZAxisOff(self) -> None C++: virtual void NormalToZAxisOff() """ pass def NormalToZAxisOn(self): # real signature unknown; restored from __doc__ """ NormalToZAxisOn(self) -> None C++: virtual void NormalToZAxisOn() """ pass def OriginTranslationOff(self): # real signature unknown; restored from __doc__ """ OriginTranslationOff(self) -> None C++: virtual void OriginTranslationOff() """ pass def OriginTranslationOn(self): # real signature unknown; restored from __doc__ """ OriginTranslationOn(self) -> None C++: virtual void OriginTranslationOn() """ pass def OutlineTranslationOff(self): # real signature unknown; restored from __doc__ """ OutlineTranslationOff(self) -> None C++: virtual void OutlineTranslationOff() """ pass def OutlineTranslationOn(self): # real signature unknown; restored from __doc__ """ OutlineTranslationOn(self) -> None C++: virtual void OutlineTranslationOn() """ pass def OutsideBoundsOff(self): # real signature unknown; restored from __doc__ """ OutsideBoundsOff(self) -> None C++: virtual void OutsideBoundsOff() """ pass def OutsideBoundsOn(self): # real signature unknown; restored from __doc__ """ OutsideBoundsOn(self) -> None C++: virtual void OutsideBoundsOn() """ pass def PlaceWidget(self, bounds, *args, **kwargs): # real signature unknown; NOTE: unreliably restored from __doc__ """ PlaceWidget(self, bounds:[float, float, float, float, float, float]) -> None C++: void PlaceWidget(double bounds[6]) override; PlaceWidget(self) -> None C++: void PlaceWidget() override; PlaceWidget(self, xmin:float, xmax:float, ymin:float, ymax:float, zmin:float, zmax:float) -> None C++: void PlaceWidget(double xmin, double xmax, double ymin, double ymax, double zmin, double zmax) override; We have to redeclare this abstract, PlaceWidget() requires it. You HAVE to override this in your concrete child classes. If there's no Prop3D and no Input, your PlaceWidget must make use of the underlying PolyDataSource to do its work. """ pass def SafeDownCast(self, o): # real signature unknown; restored from __doc__ """ SafeDownCast(o:vtkObjectBase) -> vtkImplicitPlaneWidget C++: static vtkImplicitPlaneWidget *SafeDownCast(vtkObjectBase *o) """ return vtkImplicitPlaneWidget def ScaleEnabledOff(self): # real signature unknown; restored from __doc__ """ ScaleEnabledOff(self) -> None C++: virtual void ScaleEnabledOff() """ pass def ScaleEnabledOn(self): # real signature unknown; restored from __doc__ """ ScaleEnabledOn(self) -> None C++: virtual void ScaleEnabledOn() """ pass def SetDiagonalRatio(self, _arg): # real signature unknown; restored from __doc__ """ SetDiagonalRatio(self, _arg:float) -> None C++: virtual void SetDiagonalRatio(double _arg) By default the arrow is 30% of the diagonal length. DiagonalRatio control this ratio in the interval [0-2] """ pass def SetDrawPlane(self, plane): # real signature unknown; restored from __doc__ """ SetDrawPlane(self, plane:int) -> None C++: void SetDrawPlane(vtkTypeBool plane) Enable/disable the drawing of the plane. In some cases the plane interferes with the object that it is operating on (i.e., the plane interferes with the cut surface it produces producing z-buffer artifacts.) """ pass def SetEnabled(self, __a): # real signature unknown; restored from __doc__ """ SetEnabled(self, __a:int) -> None C++: void SetEnabled(int) override; Methods that satisfy the superclass' API. """ pass def SetNormal(self, x, y, z): # real signature unknown; restored from __doc__ """ SetNormal(self, x:float, y:float, z:float) -> None C++: void SetNormal(double x, double y, double z) SetNormal(self, n:[float, float, float]) -> None C++: void SetNormal(double n[3]) Get the normal to the plane. """ pass def SetNormalToXAxis(self, __a): # real signature unknown; restored from __doc__ """ SetNormalToXAxis(self, __a:int) -> None C++: void SetNormalToXAxis(vtkTypeBool) Force the plane widget to be aligned with one of the x-y-z axes. If one axis is set on, the other two will be set off. Remember that when the state changes, a ModifiedEvent is invoked. This can be used to snap the plane to the axes if it is originally not aligned. """ pass def SetNormalToYAxis(self, __a): # real signature unknown; restored from __doc__ """ SetNormalToYAxis(self, __a:int) -> None C++: void SetNormalToYAxis(vtkTypeBool) """ pass def SetNormalToZAxis(self, __a): # real signature unknown; restored from __doc__ """ SetNormalToZAxis(self, __a:int) -> None C++: void SetNormalToZAxis(vtkTypeBool) """ pass def SetOrigin(self, x, y, z): # real signature unknown; restored from __doc__ """ SetOrigin(self, x:float, y:float, z:float) -> None C++: virtual void SetOrigin(double x, double y, double z) SetOrigin(self, x:[float, float, float]) -> None C++: virtual void SetOrigin(double x[3]) Get the origin of the plane. """ pass def SetOriginTranslation(self, _arg): # real signature unknown; restored from __doc__ """ SetOriginTranslation(self, _arg:int) -> None C++: virtual void SetOriginTranslation(vtkTypeBool _arg) Turn on/off the ability to translate the origin (sphere) with the left mouse button. """ pass def SetOutlineTranslation(self, _arg): # real signature unknown; restored from __doc__ """ SetOutlineTranslation(self, _arg:int) -> None C++: virtual void SetOutlineTranslation(vtkTypeBool _arg) Turn on/off the ability to translate the bounding box by grabbing it with the left mouse button. """ pass def SetOutsideBounds(self, _arg): # real signature unknown; restored from __doc__ """ SetOutsideBounds(self, _arg:int) -> None C++: virtual void SetOutsideBounds(vtkTypeBool _arg) Turn on/off the ability to move the widget outside of the input's bound """ pass def SetScaleEnabled(self, _arg): # real signature unknown; restored from __doc__ """ SetScaleEnabled(self, _arg:int) -> None C++: virtual void SetScaleEnabled(vtkTypeBool _arg) Turn on/off the ability to scale with the mouse """ pass def SetTubing(self, _arg): # real signature unknown; restored from __doc__ """ SetTubing(self, _arg:int) -> None C++: virtual void SetTubing(vtkTypeBool _arg) Turn on/off tubing of the wire outline of the plane. The tube thickens the line by wrapping with a vtkTubeFilter. """ pass def SizeHandles(self): # real signature unknown; restored from __doc__ """ SizeHandles(self) -> None C++: void SizeHandles() override; Control widget appearance """ pass def TubingOff(self): # real signature unknown; restored from __doc__ """ TubingOff(self) -> None C++: virtual void TubingOff() """ pass def TubingOn(self): # real signature unknown; restored from __doc__ """ TubingOn(self) -> None C++: virtual void TubingOn() """ pass def UpdatePlacement(self): # real signature unknown; restored from __doc__ """ UpdatePlacement(self) -> None C++: void UpdatePlacement() override; Satisfies the superclass API. This will change the state of the widget to match changes that have been made to the underlying PolyDataSource """ 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__\': \'vtkImplicitPlaneWidget\', \'IsTypeOf\': , \'IsA\': , \'SafeDownCast\': , \'NewInstance\': , \'GetNumberOfGenerationsFromBaseType\': , \'GetNumberOfGenerationsFromBase\': , \'SetEnabled\': , \'PlaceWidget\': , \'SetOrigin\': , \'GetOrigin\': , \'SetNormal\': , \'GetNormal\': , \'SetNormalToXAxis\': , \'GetNormalToXAxis\': , \'NormalToXAxisOn\': , \'NormalToXAxisOff\': , \'SetNormalToYAxis\': , \'GetNormalToYAxis\': , \'NormalToYAxisOn\': , \'NormalToYAxisOff\': , \'SetNormalToZAxis\': , \'GetNormalToZAxis\': , \'NormalToZAxisOn\': , \'NormalToZAxisOff\': , \'SetTubing\': , \'GetTubing\': , \'TubingOn\': , \'TubingOff\': , \'SetDrawPlane\': , \'GetDrawPlane\': , \'DrawPlaneOn\': , \'DrawPlaneOff\': , \'SetOutlineTranslation\': , \'GetOutlineTranslation\': , \'OutlineTranslationOn\': , \'OutlineTranslationOff\': , \'SetOutsideBounds\': , \'GetOutsideBounds\': , \'OutsideBoundsOn\': , \'OutsideBoundsOff\': , \'SetScaleEnabled\': , \'GetScaleEnabled\': , \'ScaleEnabledOn\': , \'ScaleEnabledOff\': , \'SetOriginTranslation\': , \'GetOriginTranslation\': , \'OriginTranslationOn\': , \'OriginTranslationOff\': , \'SetDiagonalRatio\': , \'GetDiagonalRatioMinValue\': , \'GetDiagonalRatioMaxValue\': , \'GetDiagonalRatio\': , \'GetPolyData\': , \'GetPolyDataAlgorithm\': , \'GetPlane\': , \'UpdatePlacement\': , \'SizeHandles\': , \'GetNormalProperty\': , \'GetSelectedNormalProperty\': , \'GetPlaneProperty\': , \'GetSelectedPlaneProperty\': , \'GetOutlineProperty\': , \'GetSelectedOutlineProperty\': , \'GetEdgesProperty\': , \'__new__\': , \'__repr__\': , \'__str__\': , \'__getattribute__\': , \'__setattr__\': , \'__delattr__\': , \'__dict__\': , \'__this__\': , \'__doc__\': \'vtkImplicitPlaneWidget - 3D widget for manipulating an infinite plane\\n\\nSuperclass: vtkPolyDataSourceWidget\\n\\nThis 3D widget defines an infinite plane that can be interactively\\nplaced in a scene. The widget is represented by a plane with a normal\\nvector; the plane is contained by a bounding box, and where the plane\\nintersects the bounding box the edges are shown (possibly tubed). The\\nnormal can be selected and moved to rotate the plane; the plane\\nitself can be selected and translated in various directions. As the\\nplane is moved, the implicit plane function and polygon (representing\\nthe plane cut against the bounding box) is updated.\\n\\nTo use this object, just invoke SetInteractor() with the argument of\\nthe method a vtkRenderWindowInteractor. You may also wish to invoke\\n"PlaceWidget()" to initially position the widget. If the "i" key (for\\n"interactor") is pressed, the vtkImplicitPlaneWidget will appear.\\n(See superclass documentation for information about changing this\\nbehavior.) If you select the normal vector, the plane can be\\narbitrarily rotated. The plane can be translated along the normal by\\nselecting the plane and moving it. The plane (the plane origin) can\\nalso be arbitrary moved by selecting the plane with the middle mouse\\nbutton. The right mouse button can be used to uniformly scale the\\nbounding box (moving "up" the box scales larger; moving "down" the\\nbox scales smaller). Events that occur outside of the widget (i.e.,\\nno part of the widget is picked) are propagated to any other\\nregistered obsevers (such as the interaction style). Turn off the\\nwidget by pressing the "i" key again (or invoke the Off() method).\\n\\nThe vtkImplicitPlaneWidget has several methods that can be used in\\nconjunction with other VTK objects. The GetPolyData() method can be\\nused to get a polygonal representation (the single polygon clipped by\\nthe bounding box). Typical usage of the widget is to make use of the\\nStartInteractionEvent, InteractionEvent, and EndInteractionEvent\\nevents. The InteractionEvent is called on mouse motion; the other two\\nevents are called on button down and button up (either left or right\\nbutton). (Note: there is also a PlaceWidgetEvent that is invoked when\\nthe widget is placed with PlaceWidget().)\\n\\nSome additional features of this class include the ability to control\\nthe properties of the widget. You do this by setting property values\\non the normal vector (selected and unselected properties); the plane\\n(selected and unselected properties); the outline (selected and\\nunselected properties); and the edges. The edges may also be tubed or\\nnot.\\n\\n@sa\\nvtk3DWidget vtkBoxWidget vtkPlaneWidget vtkLineWidget vtkPointWidget\\nvtkSphereWidget vtkImagePlaneWidget\\n\\n\'})' __vtkname__ = 'vtkImplicitPlaneWidget'