# 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 vtkPlaneWidget(vtkPolyDataSourceWidget): """ vtkPlaneWidget - 3D widget for manipulating a finite plane Superclass: vtkPolyDataSourceWidget This 3D widget defines a finite (bounded) plane that can be interactively placed in a scene. The plane has four handles (at its corner vertices), a normal vector, and the plane itself. The handles are used to resize the plane; the normal vector to rotate it, and the plane can be picked and translated. Selecting the plane while pressing CTRL makes it spin around the normal. A nice feature of the object is that the vtkPlaneWidget, like any 3D widget, will work with the current interactor style. That is, if vtkPlaneWidget does not handle an event, then all other registered observers (including the interactor style) have an opportunity to process the event. Otherwise, the vtkPlaneWidget will terminate the processing of the event that it handles. 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 vtkPlaneWidget will appear. (See superclass documentation for information about changing this behavior.) By grabbing the one of the four handles (use the left mouse button), the plane can be resized. By grabbing the plane itself, the entire plane can be arbitrarily translated. Pressing CTRL while grabbing the plane will spin the plane around the normal. If you select the normal vector, the plane can be arbitrarily rotated. Selecting any part of the widget with the middle mouse button enables translation of the plane along its normal. (Once selected using middle mouse, moving the mouse in the direction of the normal translates the plane in the direction of the normal; moving in the direction opposite the normal translates the plane in the direction opposite the normal.) Scaling (about the center of the plane) is achieved by using the right mouse button. By moving the mouse "up" the render window the plane will be made bigger; by moving "down" the render window the widget will be made 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 vtkPlaneWidget has several methods that can be used in conjunction with other VTK objects. The Set/GetResolution() methods control the number of subdivisions of the plane; the GetPolyData() method can be used to get the polygonal representation and can be used for things like seeding stream lines. GetPlane() can be used to update a vtkPlane implicit function. 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). Some additional features of this class include the ability to control the properties of the widget. You can set the properties of the selected and unselected representations of the plane. For example, you can set the property for the handles and plane. In addition there are methods to constrain the plane so that it is perpendicular to the x-y-z axes. @sa vtk3DWidget vtkBoxWidget vtkLineWidget vtkSphereWidget vtkImplicitPlaneWidget """ def GetCenter(self): # real signature unknown; restored from __doc__ """ GetCenter(self) -> (float, float, float) C++: double *GetCenter() GetCenter(self, xyz:[float, float, float]) -> None C++: void GetCenter(double xyz[3]) """ pass def GetHandleProperty(self): # real signature unknown; restored from __doc__ """ GetHandleProperty(self) -> vtkProperty C++: virtual vtkProperty *GetHandleProperty() Get the handle properties (the little balls are the handles). The properties of the handles when selected and normal can be manipulated. """ 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 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 GetPlane(self, plane): # real signature unknown; restored from __doc__ """ GetPlane(self, plane:vtkPlane) -> None C++: void GetPlane(vtkPlane *plane) Get the planes describing the implicit function defined by the plane widget. 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() """ pass def GetPoint1(self): # real signature unknown; restored from __doc__ """ GetPoint1(self) -> (float, float, float) C++: double *GetPoint1() GetPoint1(self, xyz:[float, float, float]) -> None C++: void GetPoint1(double xyz[3]) """ pass def GetPoint2(self): # real signature unknown; restored from __doc__ """ GetPoint2(self) -> (float, float, float) C++: double *GetPoint2() GetPoint2(self, xyz:[float, float, float]) -> None C++: void GetPoint2(double xyz[3]) """ pass def GetPolyData(self, pd): # real signature unknown; restored from __doc__ """ GetPolyData(self, pd:vtkPolyData) -> None C++: void GetPolyData(vtkPolyData *pd) Grab the polydata (including points) that defines the plane. The polydata consists of (res+1)*(res+1) points, and res*res quadrilateral polygons, where res is the resolution of the plane. These point values are guaranteed to be up-to-date when either the InteractionEvent or EndInteraction events are invoked. The user provides the vtkPolyData and the points and polyplane are added to it. """ 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. Make changes to this before calling the initial PlaceWidget() to have the initial placement follow suit. Or, make changes after the widget has been initialised and call UpdatePlacement() to realise. """ pass def GetRepresentation(self): # real signature unknown; restored from __doc__ """ GetRepresentation(self) -> int C++: virtual int GetRepresentation() """ return 0 def GetRepresentationMaxValue(self): # real signature unknown; restored from __doc__ """ GetRepresentationMaxValue(self) -> int C++: virtual int GetRepresentationMaxValue() """ return 0 def GetRepresentationMinValue(self): # real signature unknown; restored from __doc__ """ GetRepresentationMinValue(self) -> int C++: virtual int GetRepresentationMinValue() """ return 0 def GetResolution(self): # real signature unknown; restored from __doc__ """ GetResolution(self) -> int C++: int GetResolution() """ return 0 def GetSelectedHandleProperty(self): # real signature unknown; restored from __doc__ """ GetSelectedHandleProperty(self) -> vtkProperty C++: virtual vtkProperty *GetSelectedHandleProperty() """ pass def GetSelectedPlaneProperty(self): # real signature unknown; restored from __doc__ """ GetSelectedPlaneProperty(self) -> vtkProperty C++: virtual vtkProperty *GetSelectedPlaneProperty() """ 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) -> vtkPlaneWidget C++: vtkPlaneWidget *NewInstance() """ return vtkPlaneWidget 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 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) -> vtkPlaneWidget C++: static vtkPlaneWidget *SafeDownCast(vtkObjectBase *o) """ return vtkPlaneWidget def SetCenter(self, x, y, z): # real signature unknown; restored from __doc__ """ SetCenter(self, x:float, y:float, z:float) -> None C++: void SetCenter(double x, double y, double z) SetCenter(self, x:[float, float, float]) -> None C++: void SetCenter(double x[3]) Get the center of the plane. """ 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, x:[float, float, float]) -> None C++: void SetNormal(double x[3]) Get the normal to the plane. """ pass def SetNormalToXAxis(self, _arg): # real signature unknown; restored from __doc__ """ SetNormalToXAxis(self, _arg:int) -> None C++: virtual void SetNormalToXAxis(vtkTypeBool _arg) Force the plane widget to be aligned with one of the x-y-z axes. 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, _arg): # real signature unknown; restored from __doc__ """ SetNormalToYAxis(self, _arg:int) -> None C++: virtual void SetNormalToYAxis(vtkTypeBool _arg) """ pass def SetNormalToZAxis(self, _arg): # real signature unknown; restored from __doc__ """ SetNormalToZAxis(self, _arg:int) -> None C++: virtual void SetNormalToZAxis(vtkTypeBool _arg) """ pass def SetOrigin(self, x, y, z): # real signature unknown; restored from __doc__ """ SetOrigin(self, x:float, y:float, z:float) -> None C++: void SetOrigin(double x, double y, double z) SetOrigin(self, x:[float, float, float]) -> None C++: void SetOrigin(double x[3]) Set/Get the origin of the plane. """ pass def SetPlaneProperty(self, __a): # real signature unknown; restored from __doc__ """ SetPlaneProperty(self, __a:vtkProperty) -> None C++: virtual void SetPlaneProperty(vtkProperty *) Get the plane properties. The properties of the plane when selected and unselected can be manipulated. """ pass def SetPoint1(self, x, y, z): # real signature unknown; restored from __doc__ """ SetPoint1(self, x:float, y:float, z:float) -> None C++: void SetPoint1(double x, double y, double z) SetPoint1(self, x:[float, float, float]) -> None C++: void SetPoint1(double x[3]) Set/Get the position of the point defining the first axis of the plane. """ pass def SetPoint2(self, x, y, z): # real signature unknown; restored from __doc__ """ SetPoint2(self, x:float, y:float, z:float) -> None C++: void SetPoint2(double x, double y, double z) SetPoint2(self, x:[float, float, float]) -> None C++: void SetPoint2(double x[3]) Set/Get the position of the point defining the second axis of the plane. """ pass def SetRepresentation(self, _arg): # real signature unknown; restored from __doc__ """ SetRepresentation(self, _arg:int) -> None C++: virtual void SetRepresentation(int _arg) Control how the plane appears when GetPolyData() is invoked. If the mode is "outline", then just the outline of the plane is shown. If the mode is "wireframe" then the plane is drawn with the outline plus the interior mesh (corresponding to the resolution specified). If the mode is "surface" then the plane is drawn as a surface. """ pass def SetRepresentationToOff(self): # real signature unknown; restored from __doc__ """ SetRepresentationToOff(self) -> None C++: void SetRepresentationToOff() """ pass def SetRepresentationToOutline(self): # real signature unknown; restored from __doc__ """ SetRepresentationToOutline(self) -> None C++: void SetRepresentationToOutline() """ pass def SetRepresentationToSurface(self): # real signature unknown; restored from __doc__ """ SetRepresentationToSurface(self) -> None C++: void SetRepresentationToSurface() """ pass def SetRepresentationToWireframe(self): # real signature unknown; restored from __doc__ """ SetRepresentationToWireframe(self) -> None C++: void SetRepresentationToWireframe() """ pass def SetResolution(self, r): # real signature unknown; restored from __doc__ """ SetResolution(self, r:int) -> None C++: void SetResolution(int r) Set/Get the resolution (number of subdivisions) of the plane. """ pass def UpdatePlacement(self): # real signature unknown; restored from __doc__ """ UpdatePlacement(self) -> None C++: void UpdatePlacement(void) override; Satisfies 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__\': \'vtkPlaneWidget\', \'IsTypeOf\': , \'IsA\': , \'SafeDownCast\': , \'NewInstance\': , \'GetNumberOfGenerationsFromBaseType\': , \'GetNumberOfGenerationsFromBase\': , \'SetEnabled\': , \'PlaceWidget\': , \'SetResolution\': , \'GetResolution\': , \'SetOrigin\': , \'GetOrigin\': , \'SetPoint1\': , \'GetPoint1\': , \'SetPoint2\': , \'GetPoint2\': , \'SetCenter\': , \'GetCenter\': , \'SetNormal\': , \'GetNormal\': , \'SetRepresentation\': , \'GetRepresentationMinValue\': , \'GetRepresentationMaxValue\': , \'GetRepresentation\': , \'SetRepresentationToOff\': , \'SetRepresentationToOutline\': , \'SetRepresentationToWireframe\': , \'SetRepresentationToSurface\': , \'SetNormalToXAxis\': , \'GetNormalToXAxis\': , \'NormalToXAxisOn\': , \'NormalToXAxisOff\': , \'SetNormalToYAxis\': , \'GetNormalToYAxis\': , \'NormalToYAxisOn\': , \'NormalToYAxisOff\': , \'SetNormalToZAxis\': , \'GetNormalToZAxis\': , \'NormalToZAxisOn\': , \'NormalToZAxisOff\': , \'GetPolyData\': , \'GetPlane\': , \'GetPolyDataAlgorithm\': , \'UpdatePlacement\': , \'GetHandleProperty\': , \'GetSelectedHandleProperty\': , \'SetPlaneProperty\': , \'GetPlaneProperty\': , \'GetSelectedPlaneProperty\': , \'__new__\': , \'__repr__\': , \'__str__\': , \'__getattribute__\': , \'__setattr__\': , \'__delattr__\': , \'__dict__\': , \'__this__\': , \'__doc__\': \'vtkPlaneWidget - 3D widget for manipulating a finite plane\\n\\nSuperclass: vtkPolyDataSourceWidget\\n\\nThis 3D widget defines a finite (bounded) plane that can be\\ninteractively placed in a scene. The plane has four handles (at its\\ncorner vertices), a normal vector, and the plane itself. The handles\\nare used to resize the plane; the normal vector to rotate it, and the\\nplane can be picked and translated. Selecting the plane while\\npressing CTRL makes it spin around the normal. A nice feature of the\\nobject is that the vtkPlaneWidget, like any 3D widget, will work with\\nthe current interactor style. That is, if vtkPlaneWidget does not\\nhandle an event, then all other registered observers (including the\\ninteractor style) have an opportunity to process the event.\\nOtherwise, the vtkPlaneWidget will terminate the processing of the\\nevent that it handles.\\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 vtkPlaneWidget will appear. (See\\nsuperclass documentation for information about changing this\\nbehavior.) By grabbing the one of the four handles (use the left\\nmouse button), the plane can be resized. By grabbing the plane\\nitself, the entire plane can be arbitrarily translated. Pressing CTRL\\nwhile grabbing the plane will spin the plane around the normal. If\\nyou select the normal vector, the plane can be arbitrarily rotated.\\nSelecting any part of the widget with the middle mouse button enables\\ntranslation of the plane along its normal. (Once selected using\\nmiddle mouse, moving the mouse in the direction of the normal\\ntranslates the plane in the direction of the normal; moving in the\\ndirection opposite the normal translates the plane in the direction\\nopposite the normal.) Scaling (about the center of the plane) is\\nachieved by using the right mouse button. By moving the mouse "up"\\nthe render window the plane will be made bigger; by moving "down" the\\nrender window the widget will be made smaller. Events that occur\\noutside of the widget (i.e., no part of the widget is picked) are\\npropagated to any other registered obsevers (such as the interaction\\nstyle). Turn off the widget by pressing the "i" key again (or invoke\\nthe Off() method).\\n\\nThe vtkPlaneWidget has several methods that can be used in\\nconjunction with other VTK objects. The Set/GetResolution() methods\\ncontrol the number of subdivisions of the plane; the GetPolyData()\\nmethod can be used to get the polygonal representation and can be\\nused for things like seeding stream lines. GetPlane() can be used to\\nupdate a vtkPlane implicit function. Typical usage of the widget is\\nto make use of the StartInteractionEvent, InteractionEvent, and\\nEndInteractionEvent events. The InteractionEvent is called on mouse\\nmotion; the other two events are called on button down and button up\\n(either left or right button).\\n\\nSome additional features of this class include the ability to control\\nthe properties of the widget. You can set the properties of the\\nselected and unselected representations of the plane. For example,\\nyou can set the property for the handles and plane. In addition there\\nare methods to constrain the plane so that it is perpendicular to the\\nx-y-z axes.\\n\\n@sa\\nvtk3DWidget vtkBoxWidget vtkLineWidget vtkSphereWidget\\nvtkImplicitPlaneWidget\\n\\n\'})' __vtkname__ = 'vtkPlaneWidget'