# encoding: utf-8
# module vtkmodules.vtkCommonDataModel
# from C:\Users\xukai\Downloads\发票2\venv\Lib\site-packages\vtkmodules\vtkCommonDataModel.cp311-win_amd64.pyd
# by generator 1.147
# no doc

# imports
import vtkmodules.vtkCommonCore as __vtkmodules_vtkCommonCore
import vtkmodules.vtkCommonMath as __vtkmodules_vtkCommonMath
import vtkmodules.vtkCommonTransforms as __vtkmodules_vtkCommonTransforms


from .vtkImplicitFunction import vtkImplicitFunction

class vtkImplicitVolume(vtkImplicitFunction):
    """
    vtkImplicitVolume - treat a volume as if it were an implicit function
    
    Superclass: vtkImplicitFunction
    
    vtkImplicitVolume treats a volume (e.g., structured point dataset) as
    if it were an implicit function. This means it computes a function
    value and gradient. vtkImplicitVolume is a concrete implementation of
    vtkImplicitFunction.
    
    vtkImplicitDataSet computes the function (at the point x) by
    performing cell interpolation. That is, it finds the cell containing
    x, and then uses the cell's interpolation functions to compute an
    interpolated scalar value at x. (A similar approach is used to find
    the gradient, if requested.) Points outside of the dataset are
    assigned the value of the ivar OutValue, and the gradient value
    OutGradient.
    
    @warning
    The input volume data is only updated when GetMTime() is called.
    Works for 3D structured points datasets, 0D-2D datasets won't work
    properly.
    
    @sa
    vtkImplicitFunction vtkImplicitDataSet vtkClipPolyData vtkCutter
    vtkImplicitWindowFunction
    """
    def EvaluateFunction(self, x, *args, **kwargs): # real signature unknown; NOTE: unreliably restored from __doc__ 
        """
        EvaluateFunction(self, x:[float, float, float]) -> float
        C++: double EvaluateFunction(double x[3]) override;
        EvaluateFunction(self, input:vtkDataArray, output:vtkDataArray)
            -> None
        C++: virtual void EvaluateFunction(vtkDataArray *input,
            vtkDataArray *output)
        EvaluateFunction(self, x:float, y:float, z:float) -> float
        C++: virtual double EvaluateFunction(double x, double y, double z)
        
        Evaluate function at position x-y-z and return value.  You should
        generally not call this method directly, you should use
        FunctionValue() instead.  This method must be implemented by any
        derived class.
        """
        pass

    def EvaluateGradient(self, x, *args, **kwargs): # real signature unknown; NOTE: unreliably restored from __doc__ 
        """
        EvaluateGradient(self, x:[float, float, float], n:[float, float,
            float]) -> None
        C++: void EvaluateGradient(double x[3], double n[3]) override;
        
        Evaluate ImplicitVolume gradient.
        """
        pass

    def GetMTime(self): # real signature unknown; restored from __doc__
        """
        GetMTime(self) -> int
        C++: vtkMTimeType GetMTime() override;
        
        Returns the mtime also considering the volume.  This also calls
        Update on the volume, and it therefore must be called before the
        function is evaluated.
        """
        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 GetOutGradient(self): # real signature unknown; restored from __doc__
        """
        GetOutGradient(self) -> (float, float, float)
        C++: virtual double *GetOutGradient()
        """
        pass

    def GetOutValue(self): # real signature unknown; restored from __doc__
        """
        GetOutValue(self) -> float
        C++: virtual double GetOutValue()
        """
        return 0.0

    def GetVolume(self): # real signature unknown; restored from __doc__
        """
        GetVolume(self) -> vtkImageData
        C++: virtual vtkImageData *GetVolume()
        """
        return vtkImageData

    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) -> vtkImplicitVolume
        C++: vtkImplicitVolume *NewInstance()
        """
        return vtkImplicitVolume

    def SafeDownCast(self, o): # real signature unknown; restored from __doc__
        """
        SafeDownCast(o:vtkObjectBase) -> vtkImplicitVolume
        C++: static vtkImplicitVolume *SafeDownCast(vtkObjectBase *o)
        """
        return vtkImplicitVolume

    def SetOutGradient(self, _arg1, _arg2, _arg3): # real signature unknown; restored from __doc__
        """
        SetOutGradient(self, _arg1:float, _arg2:float, _arg3:float)
            -> None
        C++: virtual void SetOutGradient(double _arg1, double _arg2,
            double _arg3)
        SetOutGradient(self, _arg:(float, float, float)) -> None
        C++: virtual void SetOutGradient(const double _arg[3])
        
        Set the function gradient to use for points outside of the
        dataset.
        """
        pass

    def SetOutValue(self, _arg): # real signature unknown; restored from __doc__
        """
        SetOutValue(self, _arg:float) -> None
        C++: virtual void SetOutValue(double _arg)
        
        Set the function value to use for points outside of the dataset.
        """
        pass

    def SetVolume(self, __a): # real signature unknown; restored from __doc__
        """
        SetVolume(self, __a:vtkImageData) -> None
        C++: virtual void SetVolume(vtkImageData *)
        
        Specify the volume for the implicit function.
        """
        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__\': \'vtkImplicitVolume\', \'IsTypeOf\': <method \'IsTypeOf\' of \'vtkmodules.vtkCommonDataModel.vtkImplicitVolume\' objects>, \'IsA\': <method \'IsA\' of \'vtkmodules.vtkCommonDataModel.vtkImplicitVolume\' objects>, \'SafeDownCast\': <method \'SafeDownCast\' of \'vtkmodules.vtkCommonDataModel.vtkImplicitVolume\' objects>, \'NewInstance\': <method \'NewInstance\' of \'vtkmodules.vtkCommonDataModel.vtkImplicitVolume\' objects>, \'GetNumberOfGenerationsFromBaseType\': <method \'GetNumberOfGenerationsFromBaseType\' of \'vtkmodules.vtkCommonDataModel.vtkImplicitVolume\' objects>, \'GetNumberOfGenerationsFromBase\': <method \'GetNumberOfGenerationsFromBase\' of \'vtkmodules.vtkCommonDataModel.vtkImplicitVolume\' objects>, \'GetMTime\': <method \'GetMTime\' of \'vtkmodules.vtkCommonDataModel.vtkImplicitVolume\' objects>, \'EvaluateFunction\': <method \'EvaluateFunction\' of \'vtkmodules.vtkCommonDataModel.vtkImplicitVolume\' objects>, \'EvaluateGradient\': <method \'EvaluateGradient\' of \'vtkmodules.vtkCommonDataModel.vtkImplicitVolume\' objects>, \'SetVolume\': <method \'SetVolume\' of \'vtkmodules.vtkCommonDataModel.vtkImplicitVolume\' objects>, \'GetVolume\': <method \'GetVolume\' of \'vtkmodules.vtkCommonDataModel.vtkImplicitVolume\' objects>, \'SetOutValue\': <method \'SetOutValue\' of \'vtkmodules.vtkCommonDataModel.vtkImplicitVolume\' objects>, \'GetOutValue\': <method \'GetOutValue\' of \'vtkmodules.vtkCommonDataModel.vtkImplicitVolume\' objects>, \'SetOutGradient\': <method \'SetOutGradient\' of \'vtkmodules.vtkCommonDataModel.vtkImplicitVolume\' objects>, \'GetOutGradient\': <method \'GetOutGradient\' of \'vtkmodules.vtkCommonDataModel.vtkImplicitVolume\' objects>, \'__new__\': <built-in method __new__ of type object at 0x00007FF81D632C90>, \'__repr__\': <slot wrapper \'__repr__\' of \'vtkmodules.vtkCommonDataModel.vtkImplicitVolume\' objects>, \'__str__\': <slot wrapper \'__str__\' of \'vtkmodules.vtkCommonDataModel.vtkImplicitVolume\' objects>, \'__getattribute__\': <slot wrapper \'__getattribute__\' of \'vtkmodules.vtkCommonDataModel.vtkImplicitVolume\' objects>, \'__setattr__\': <slot wrapper \'__setattr__\' of \'vtkmodules.vtkCommonDataModel.vtkImplicitVolume\' objects>, \'__delattr__\': <slot wrapper \'__delattr__\' of \'vtkmodules.vtkCommonDataModel.vtkImplicitVolume\' objects>, \'__dict__\': <attribute \'__dict__\' of \'vtkmodules.vtkCommonDataModel.vtkImplicitVolume\' objects>, \'__this__\': <attribute \'__this__\' of \'vtkmodules.vtkCommonDataModel.vtkImplicitVolume\' objects>, \'__doc__\': "vtkImplicitVolume - treat a volume as if it were an implicit function\\n\\nSuperclass: vtkImplicitFunction\\n\\nvtkImplicitVolume treats a volume (e.g., structured point dataset) as\\nif it were an implicit function. This means it computes a function\\nvalue and gradient. vtkImplicitVolume is a concrete implementation of\\nvtkImplicitFunction.\\n\\nvtkImplicitDataSet computes the function (at the point x) by\\nperforming cell interpolation. That is, it finds the cell containing\\nx, and then uses the cell\'s interpolation functions to compute an\\ninterpolated scalar value at x. (A similar approach is used to find\\nthe gradient, if requested.) Points outside of the dataset are\\nassigned the value of the ivar OutValue, and the gradient value\\nOutGradient.\\n\\n@warning\\nThe input volume data is only updated when GetMTime() is called.\\nWorks for 3D structured points datasets, 0D-2D datasets won\'t work\\nproperly.\\n\\n@sa\\nvtkImplicitFunction vtkImplicitDataSet vtkClipPolyData vtkCutter\\nvtkImplicitWindowFunction\\n\\n"})'
    __vtkname__ = 'vtkImplicitVolume'


