GiProceduralGenerator.h

Go to the documentation of this file.

// Copyright (C) 2002-2024, Open Design Alliance (the "Alliance"). 
// All rights reserved. 
// 
// This software and its documentation and related materials are owned by 
// the Alliance. The software may only be incorporated into application 
// programs owned by members of the Alliance, subject to a signed 
// Membership Agreement and Supplemental Software License Agreement with the
// Alliance. The structure and organization of this software are the valuable  
// trade secrets of the Alliance and its suppliers. The software is also 
// protected by copyright law and international treaty provisions. Application  
// programs incorporating this software must include the following statement 
// with their copyright notices:
//   
//   This application incorporates Open Design Alliance software pursuant to a license 
//   agreement with Open Design Alliance.
//   Open Design Alliance Copyright (C) 2002-2024 by Open Design Alliance. 
//   All rights reserved.
//
// By use of this software, its documentation or related materials, you 
// acknowledge and accept the above terms.
 
// Procedural textures generator.
 
#ifndef __ODGIPROCEDURALGENERATOR_H__
#define __ODGIPROCEDURALGENERATOR_H__
 
#include "RootExport.h"
#include "GiExport.h"
#include "UInt32Array.h"
#include "GiImage.h"
#include "GiMaterial.h"
 
#include "RxObject.h"
 
#include "TD_PackPush.h"

class ODGI_EXPORT OdGiProceduralGeneratorPE : public OdRxObject
{
  public:
    ODRX_DECLARE_MEMBERS(OdGiProceduralGeneratorPE);

    OdGiProceduralGeneratorPE();

    virtual bool generateProceduralTexture(OdGiProceduralTexturePtr pTexture,
                                           OdGiImageBGRA32 &image, double renderCoef = 1.0) = 0;
};

typedef OdSmartPtr<OdGiProceduralGeneratorPE> OdGiProceduralGeneratorPEPtr;

class ODGI_EXPORT OdGiGradientGenerator
{
  public:
    enum InterpolationType
    {
      kLinearInterpolation = 0,
      kExpInterpolation,
      kInvExpInterpolation,
      kCosInterpolation
    };

    enum AddressMode
    {
      kClampMode = 0,
      kWrapMode
    };
  protected:
    OdUInt32Array m_colorGradient;
    AddressMode m_addressMode;
  public:
    OdGiGradientGenerator();
    
    OdGiGradientGenerator(const OdGiGradientGenerator &other);
    
    ~OdGiGradientGenerator();

    void createColorArray(OdUInt32 nColors);
    void createColorArrayFilled(ODCOLORREF color, OdUInt32 nColors);
    void copyGradient(const OdUInt32Array &other);
    void copyGradient(const ODCOLORREF *colors, OdUInt32 nColors);
    void createGradient(ODCOLORREF color1, ODCOLORREF color2, OdUInt32 nColors,
                        OdGiGradientGenerator::InterpolationType ipl = OdGiGradientGenerator::kLinearInterpolation);
    void createGradient(ODCOLORREF color1, ODCOLORREF color2, ODCOLORREF color3, OdUInt32 nColors,
                        OdGiGradientGenerator::InterpolationType ipl = OdGiGradientGenerator::kLinearInterpolation);
    void createGradient(ODCOLORREF color1, ODCOLORREF color2, ODCOLORREF color3, OdUInt32 nColors,
                        OdGiGradientGenerator::InterpolationType ipl1, OdGiGradientGenerator::InterpolationType ipl2);
    void createGradient(ODCOLORREF color1, ODCOLORREF color2, ODCOLORREF color3, ODCOLORREF color4, OdUInt32 nColors,
                        OdGiGradientGenerator::InterpolationType ipl = OdGiGradientGenerator::kLinearInterpolation);
    void createGradient(ODCOLORREF color1, ODCOLORREF color2, ODCOLORREF color3, ODCOLORREF color4, OdUInt32 nColors,
                        OdGiGradientGenerator::InterpolationType ipl1, OdGiGradientGenerator::InterpolationType ipl2,
                        OdGiGradientGenerator::InterpolationType ipl3);
    void createGradient(ODCOLORREF color1, ODCOLORREF color2, ODCOLORREF color3, ODCOLORREF color4, ODCOLORREF color5, OdUInt32 nColors,
                        OdGiGradientGenerator::InterpolationType ipl = OdGiGradientGenerator::kLinearInterpolation);
    void createGradient(ODCOLORREF color1, ODCOLORREF color2, ODCOLORREF color3, ODCOLORREF color4, ODCOLORREF color5, OdUInt32 nColors,
                        OdGiGradientGenerator::InterpolationType ipl1, OdGiGradientGenerator::InterpolationType ipl2,
                        OdGiGradientGenerator::InterpolationType ipl3, OdGiGradientGenerator::InterpolationType ipl4);

    void fillInterval(ODCOLORREF color, double from = 0.0, double to = 1.0);
    void fillInterval(ODCOLORREF color, OdUInt32 from, OdUInt32 to);
    void generateInterval(ODCOLORREF color1, ODCOLORREF color2, double from = 0.0, double to = 1.0,
                          OdGiGradientGenerator::InterpolationType ipl = OdGiGradientGenerator::kLinearInterpolation);
    void generateInterval(ODCOLORREF color1, ODCOLORREF color2, OdUInt32 from, OdUInt32 to,
                          OdGiGradientGenerator::InterpolationType ipl = OdGiGradientGenerator::kLinearInterpolation);

    OdUInt32 colorsCount() const;
    ODCOLORREF colorAt(OdUInt32 nColor) const;
    ODCOLORREF colorAt(double at) const;
    bool isInitialized() const;
    const OdUInt32Array &asArray() const;

    void setAddressMode(OdGiGradientGenerator::AddressMode mode);
    OdGiGradientGenerator::AddressMode addressMode() const;

    static ODCOLORREF interpolateColor(ODCOLORREF color1, ODCOLORREF color2, double at,
                                       OdGiGradientGenerator::InterpolationType ipl = OdGiGradientGenerator::kLinearInterpolation,
                                       OdGiGradientGenerator::AddressMode mode = OdGiGradientGenerator::kWrapMode);

    const OdGiGradientGenerator &operator =(const OdGiGradientGenerator &other);

    static OdGiGradientGenerator createSpectrumGradient(OdUInt32 nColors, OdUInt8 alpha = 0);

    void appendGradient(const OdGiGradientGenerator &other);
    
    void operator +=(const OdGiGradientGenerator &other);
    friend OdGiGradientGenerator operator +(const OdGiGradientGenerator &g1, const OdGiGradientGenerator &g2);
  protected:
    OdUInt32 clampToRange(OdUInt32 inVal) const;
    OdUInt32 clampToRange(double inVal) const;
    double toDoubleRange(OdUInt32 inVal) const;

    static double linterp(double a, double b, double t);
    static double einterp(double a, double b, double t);
    static double cinterp(double a, double b, double t);
    static double ieinterp(double a, double b, double t);
};

class ODGI_EXPORT OdGiProceduralGenerator : public OdRxObject
{
  public:
    ODRX_DECLARE_MEMBERS(OdGiProceduralGenerator);
 
    // High-level functions

    virtual bool generateProceduralTexture(OdGiProceduralTexturePtr pTexture,
                                           OdGiImageBGRA32 &image, double renderCoef = 1.0) = 0;

    virtual void generateProceduralWood(OdGiPixelBGRA32 color1, OdGiPixelBGRA32 color2, double radialNoise, double axialNoise, double grainThickness,
                                        OdGiImageBGRA32 &image, double renderCoef = 1.0) = 0;
    virtual void generateProceduralMarble(OdGiPixelBGRA32 stoneColor, OdGiPixelBGRA32 veinColor, double veinSpacing, double veinWidth,
                                          OdGiImageBGRA32 &image, double renderCoef = 1.0) = 0;
 
    // Low-level functions

    virtual void setColorGradient(const OdGiGradientGenerator &gradient) = 0;
    virtual const OdGiGradientGenerator &colorGradient() const = 0;
};

typedef OdSmartPtr<OdGiProceduralGenerator> OdGiProceduralGeneratorPtr;
 
#include "TD_PackPop.h"
 
#endif // __ODGIPROCEDURALGENERATOR_H__