 |
ImFusion C++ SDK 4.4.0
|
|
ImFusion C++ SDK 4.4.0
|
#include <ImFusion/ImageMath/Tpl/OperandDeformation.h>
Use an ImageMath expression as a Deformation. More...
Use an ImageMath expression as a Deformation.
The expression must have 3 channels and is interpreted as the displacement in world coordinates. Example, here si is a SharedImage object:
Public Member Functions | |
| OperandDeformation (const OperandT operand, ImageDescriptorWorld descriptorWorld) | |
| vec3 | displacement (const vec3 &pos) const override |
| Deformation interface Here pos is in world coordinates, and the result is expected to be in world coordinates also. | |
| std::vector< GL::AbstractInclude * > | dependentIncludes () const override |
| Returns a list of dependent abstract includes that need to be included as well. | |
| int | setIncludeArguments (GL::Program &p, const SharedImage *img, const std::string &prefix="deform") const override |
| Override default arguments for GlMask includes. | |
| Deformation * | clone () const override |
| Returns a copy of the deformation. | |
| int | dimension () const override |
| Returns the dimension of the deformation. | |
| virtual bool | isIdentity () const override |
| Returns if the current state of the deformation transformations the image or not. | |
| virtual void | setIdentity () override |
| This function is not supported by OperandDeformation. | |
| std::string | id () const override |
| Returns a unique string identifier for this type of deformation. | |
| Public Member Functions inherited from ImFusion::Deformation | |
| Deformation (const std::string &shaderPath) | |
| Initializes the Deformation with path to the GlInclude file. | |
| virtual vec3 | displacement (const vec2 &pos) const |
| Returns the displacement at the world position pos. | |
| virtual vec3 | displacePoint (const vec3 &point) const |
| Returns the displaced position of the given point in world-coordinates. | |
| void | setDisabled (bool flag) |
| Set a disabled flag in order to hide the visualization of this deformation. | |
| bool | disabled () const |
| Return whether the deformation was set to disabled. | |
| virtual std::unique_ptr< SharedImageSet > | supportingImages () const |
| Returns the images that, together with the configuration, defines the deformation. | |
| Public Member Functions inherited from ImFusion::GL::AbstractInclude | |
| AbstractInclude (const std::string &defineName, const std::string &includePath) | |
| Creates a AbstractInclude for the given define and with the corresponding GLSL file at includePath. | |
| const std::string & | defineName () const |
| Returns the name of define used by this include. | |
| const std::string & | includePath () const |
| Returns the path to the included shader file. | |
| virtual std::function< std::string(const std::string &)> | includeCodeSubstitution () const |
| Optionally the abstract include can provide a function to change the shader code. | |
| virtual Fingerprint | fingerprint () const |
| Provides a finger print of the include. | |
| Public Member Functions inherited from ImFusion::GL::MultiIncludable< Deformation, const SharedImage * > | |
| std::shared_ptr< MultiIncludeType > | createMultiInclude (const std::string &replacementToken) |
| Instantiates a new AbstractInclude instance where all occurrences of baseToken provided during construction are replaces with replacementToken according to the specified replacementScheme. | |
| virtual int | setIncludeArguments (Program &prog, IncludeArgumentsTypes... includeArgs, const std::string &token) const=0 |
| Interface that multi includes should use to configure the shader include (such as setting uniforms, binding textures, etc). | |
| Public Member Functions inherited from ImFusion::Configurable | |
| virtual void | configure (const Properties *p) |
| Configure this object instance by de-serializing the given Properties. | |
| virtual void | configuration (Properties *p) const |
| Serialize the current object configuration into the given Properties object. | |
| virtual void | configureDefaults () |
| Retrieve the properties of this object, replaces values with their defaults and sets it again. | |
| void | registerParameter (ParameterBase *param) |
| Register the given Parameter or SubProperty, so that it will be configured during configure()/configuration(). | |
| void | unregisterParameter (const ParameterBase *param) |
| Remove the given Parameter or SubProperty from the list of registered parameters. | |
| Configurable (const Configurable &rhs) | |
| Configurable (Configurable &&rhs) noexcept | |
| Configurable & | operator= (const Configurable &) |
| Configurable & | operator= (Configurable &&) noexcept |
Additional Inherited Members | |
| Public Types inherited from ImFusion::GL::MultiIncludable< Deformation, const SharedImage * > | |
| using | MultiIncludeType |
| Alias for type of a multi-include instance of the original include. | |
| Static Public Member Functions inherited from ImFusion::Deformation | |
| static std::string | defineName () |
| Returns the define name of GlAbstractInclude for all deformations. | |
| static std::string | defineSuffix () |
| Returns "DEFORM". | |
| static std::string | multiIncludeDefine (const std::string &replacementToken) |
| Returns "IMAGE_" + toUpper(replacementToken). | |
| Public Attributes inherited from ImFusion::Deformation | |
| Signal< const DeformationEvent & > | signalChanged |
| Public Attributes inherited from ImFusion::Configurable | |
| Signal | signalParametersChanged |
| Emitted whenever one of the registered Parameters' or SubPropertys' signalValueChanged signal was emitted. | |
| Protected Member Functions inherited from ImFusion::Deformation | |
| void | notifyListeners (const DeformationEvent &event) const |
| convenience function to call signalChanged.emitSignal(event). | |
| Protected Member Functions inherited from ImFusion::GL::MultiIncludable< Deformation, const SharedImage * > | |
| MultiIncludable (Deformation *crtpInstance, const std::string &baseToken, Flags< ShaderTextReplacement > replacementScheme) | |
| Instantiate and configure the MultiIncludable interface. | |
| Protected Attributes inherited from ImFusion::Deformation | |
| bool | m_disabled |
| Disabled flag for visualization. | |
| Protected Attributes inherited from ImFusion::Configurable | |
| std::vector< Param > | m_params |
| List of all registered Parameter and SubProperty instances. | |
|
inlineoverridevirtual |
Deformation interface Here pos is in world coordinates, and the result is expected to be in world coordinates also.
Implements ImFusion::Deformation.
|
inlineoverridevirtual |
Returns a list of dependent abstract includes that need to be included as well.
The default implementation returns an empty vector, you may override this method to your needs. The returned vector must be empty or contain valid pointers.
Reimplemented from ImFusion::GL::AbstractInclude.
|
inlineoverridevirtual |
Override default arguments for GlMask includes.
Implements ImFusion::Deformation.
|
inlineoverridevirtual |
Returns a copy of the deformation.
Implements ImFusion::Deformation.
|
inlineoverridevirtual |
Returns the dimension of the deformation.
Implements ImFusion::Deformation.
|
inlineoverridevirtual |
Returns if the current state of the deformation transformations the image or not.
Implements ImFusion::Deformation.
|
inlineoverridevirtual |
This function is not supported by OperandDeformation.
Implements ImFusion::Deformation.
|
inlineoverridevirtual |
Returns a unique string identifier for this type of deformation.
Usually the name of the class.
Implements ImFusion::Deformation.