mmf
Class MMF_GradientLayerMerge

Object
  common:Generic
      mmf:MMF_LayerMergeBase
          mmf:MMF_LayerMerge
              mmf:MMF_GradientLayerMerge

class 
MMF_LayerMerge:MMF_GradientLayerMerge

PLEASE NOTE This class is obsolete/deprecated.
Instead of using this class and its derived classes you should use
the Layer class and its derived classes.

Ultra Fractal Source

Toggle UF Source Code Display

 class MMF_GradientLayerMerge(MMF_LayerMerge) {
 ; PLEASE NOTE This class is obsolete/deprecated.<br>
 ; Instead of using this class and its derived classes you should use<br>
 ; the Layer class and its derived classes.<br>
 public:
   import "common.ulb"
   ; <p>
   ; @param pparent typically 'this' from the parent or zero
   func MMF_GradientLayerMerge(Generic pparent)
     MMF_LayerMergeBase.MMF_LayerMergeBase(pparent)
     if @f_grad==0
       m_Gradient = new @f_gradient(this)
     endif
   endfunc
   ; <p>
   ; @param clr the base color
   ; @param index the gradient index for the top colour
   ; @return layer merged color
   color func GradientMerge(color clr,float index)
     if @f_grad==0
       return FullMerge(clr, m_Gradient.GetColour(index))
     else
       return FullMerge(clr, gradient(index))
     endif
   endfunc
 
 private:
   MMF_UserGradient m_Gradient
 
 default:
   title = "MMF Layer Merge with Gradient"
   int param v_mmfgradientlayermerge
     caption = "Version (MMF Layer Merge with Gradient)"
     enum = "1.0"
     default = 0
     hint = "This field is to absolutely ensure backward compatibility, \
             the default will always be set to the latest version, but \
             there may be some cases where an older effect that you like \
             is lost in an update and you could still use it by selecting \
             the older version number."
     visible = false
   endparam
   int param f_grad
     caption = "Gradient to use"
     enum = "Custom Gradient" "UF's Gradient"
     default = 0
   endparam
   MMF_UserGradient param f_gradient
     caption = "Layer Gradient"
     default = MMF_Gradient101
     hint = "Allows you to customise the colours for this layer."
     visible = @f_grad==0
   endparam
 }
 

Constructor Summary

MMF_GradientLayerMerge()

MMF_GradientLayerMerge(Generic pparent)

Method Summary

color

GradientMerge(color clr, float index)

Methods inherited from class mmf:MMF_LayerMerge

Merge

Methods inherited from class mmf:MMF_LayerMergeBase

FullMerge, SolidMerge

Methods inherited from class common:Generic

GetParent

Methods inherited from class Object

Constructor Detail

MMF_GradientLayerMerge

public MMF_GradientLayerMerge(Generic pparent)

Parameters:

pparent - typically 'this' from the parent or zero

MMF_GradientLayerMerge

public MMF_GradientLayerMerge()

Method Detail

GradientMerge

public color GradientMerge(color clr,
                           float index)

Overrides:

GradientMerge in class MMF_LayerMergeBase

Parameters:

clr - the base color

index - the gradient index for the top colour

Returns:

layer merged color