common
Class Generic

Object
  common:Generic

Direct Known Subclasses:

Coloring, ColorMerge, ColorTransfer, ColorTrap, ComplexInterpolator, Contraction, DMJ_ConvolutionFilter, DMJ_PolyCurveSelector, DualTransform, Easing, Formula, Generator, GradientWrapper, ImageTrapColoring, ImageTrapMode, ImageWrapper, IntegerGenerator, IntegerTransfer, InterpolateBase, InvertSphere, JLB_Random, Layer, MappingShape, MMF_AltfBm, MMF_DeadDLA, MMF_LayerMergeBase, MMF_SeedDLA, MMF_StimulusDLA, MMF_UserGradient, MT_Kernel, RaytraceGeneric, REB_DirectColorHelper, Reduction, Transfer, Transform, TrapColoring, TrapMode, TrapShape

class 
Object:Generic

Generic base class.

This is a generic object class. Most of the other classes derive from this class. Its primary purpose is to act as glue between all of the objects that are used within a formula.

Each class in UF derives from the built-in Object class, so this class may seem a bit redundant. But eventually this class will be extended to include some parameter-passing functions, which will require all major classes to derive from a common extensible parent. If your class is intended to be user-selectable and has any user-selectable parameters at all, you should probably derive it from this class.

Ultra Fractal Source

Toggle UF Source Code Display

 class Generic {
   ; Generic base class.
   ; <p>
   ; This is a generic object class. Most of the other classes
   ; derive from this class. Its primary purpose is to act as
   ; glue between all of the objects that are used within a
   ; formula.
   ; <p>
   ; Each class in UF derives from the built-in Object class,
   ; so this class may seem a bit redundant. But eventually
   ; this class will be extended to include some parameter-passing
   ; functions, which will require all major classes to derive
   ; from a common extensible parent. If your class is intended
   ; to be user-selectable and has any user-selectable parameters
   ; at all, you should probably derive it from this class.
 
 public:
   ; Constructor
   ;
   ; @param pparent a reference to the object creating the new object; typically, 'this'
   func Generic(Generic pparent)
     m_Parent = pparent
   endfunc
 
   ; Fetch parent object
   ;
   ; @return a reference to the object that created this object;
   ; you can repeatedly apply this function to the resulting object
   ; reference until a null (0) is returned, and the object that
   ; gave the null return value is the "top" object.
   Generic func GetParent()
     return m_Parent
   endfunc
 
 protected:
   ; A reference to the parent object.
   Generic m_Parent
 
 default:
   int param v_generic
     caption = "Version (Generic)"
     default = 100
     hint = "This version parameter is used to detect when a change has been made to the formula that is incompatible with the previous version. When that happens, this field will reflect the old version number to alert you to the fact that an alternate rendering is being used."
     visible = @v_generic < 100
   endparam
 }
 

Constructor Summary

Generic()

Generic(Generic pparent)
Constructor

Method Summary

Generic

GetParent() Fetch parent object

Methods inherited from class Object

Constructor Detail

Generic

public Generic(Generic pparent)

Constructor

Parameters:

pparent - a reference to the object creating the new object; typically, 'this'

Generic

public Generic()

Method Detail

GetParent

public Generic GetParent()

Fetch parent object

Returns:

a reference to the object that created this object; you can repeatedly apply this function to the resulting object reference until a null (0) is returned, and the object that gave the null return value is the "top" object.