AveMaterial.h

Go to the documentation of this file.

 
// Copyright (C) 2002-2022, 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-2022 by Open Design Alliance. 
//   All rights reserved.
//
// By use of this software, its documentation or related materials, you 
// acknowledge and accept the above terms.
 
 
 
#ifndef OD_AVEMATERIAL_H
#define OD_AVEMATERIAL_H
 
#include "TD_PackPush.h"
 
#include "Ve/AveDefs.h"
#include "RxObject.h"
#include "DbEntity.h"
#include "IdArrays.h"
 
class OdDbObjectId;
class OdDbDatabase;
class OdAveMaterialImpl;
class OdAveMaterial;
typedef OdSmartPtr<OdAveMaterial> OdAveMaterialPtr;
 
class AVE_EXPORT OdAveMaterial : public OdRxObject
{
public:
  ODRX_DECLARE_MEMBERS(OdAveMaterial);
 
  static OdAveMaterialPtr getMaterial(const OdDbObjectId& blockRefId);
 
  static OdString getMaterialName(const OdDbObjectId& blockRefId);
 
  OdResult writeMaterial(OdDbDatabase* pDb = NULL, const OdDbHandle& holderHandle = 0);
 
  bool attachToObject(OdDbObjectId entityId);
 
  bool attachToLayer(OdDbObjectId layerId);
 
  bool attachToACI(OdUInt16 colorIndex);
  
  static void detachFromObject(OdDbObjectId entityId);
 
  static void detachFromLayer(OdDbObjectId layerId);
 
  static void detachFromACI(OdDbDatabase* pDb, OdUInt16 colorIndex);
  
  static bool getAttachedMaterial(const OdDbObjectId& sourceId, OdDbObjectId& blockRefId);
  
  static bool getAttachedMaterial(OdDbDatabase* pDb, OdUInt16 colorIndex, OdDbObjectId& blockRefId);
 
  static void getAciMaterialMap(OdDbDatabase* pDb, OdDbObjectIdArray& blockRefIds);
 
  virtual OdAve::MaterialType type();
 
  bool isAttribUsed(OdAve::MaterialAttrib attributes);
 
  OdString name() const;
  OdString description() const;
 
  void setName(const OdString& name);
 
  void setDescription(const OdString& description);
 
  double ambientFactor() const;
 
  OdUInt32 ambientColor() const;
  bool ambientColorCurrent() const;
 
  bool ambientLock() const;
 
  void setAmbientFactor(double ambientFactor);
 
  void setAmbientColor(OdUInt32 ambientColor);
  void setAmbientColorCurrent(bool currentColor);
  void setAmbientLock(bool ambientLock);
 
 
  double diffuseFactor() const;
 
  OdUInt32 diffuseColor() const;
  
  bool diffuseColorCurrent() const;
  
  
  OdAveBitmap& diffuseBitmap() const;
 
  void setDiffuseFactor(double diffuseFactor);
  void setDiffuseColor(OdUInt32 diffuseColor);
 
  void setDiffuseColorCurrent(bool currentColor);
 
  double specularFactor() const;
 
  OdUInt32 specularColor() const;
  bool specularColorCurrent() const;
  bool specularMirror() const;
  
  bool specularLock() const;
  
  OdAveBitmap& specularBitmap();
  const OdAveBitmap& specularBitmap() const;
 
 
  void setSpecularFactor(double specularFactor);
  void setSpecularColor(OdUInt32 specularColor);
 
  void setSpecularColorCurrent(bool colorCurrrent);
  void setSpecularMirror(bool mirror);
 
  void setSpecularLock(bool specularLock);
 
  double roughness() const;
  void setRoughness(double);
 
  double transparency() const;
  OdAveBitmap& transparencyBitmap() const;
  void setTransparency(double transparency);
 
  double refraction() const;
 
  void setRefraction(double refraction) const;
 
  OdAveBitmap& bumpMap();
  const OdAveBitmap& bumpMap() const;
 
  OdDbObjectId holderId() const;
 
  OdString handleDbMaterial() const;
 
  void setHandleDbMaterial(const OdString& sDesc);
 
  ~OdAveMaterial();
protected:
  OdAveMaterial();
  OdAveMaterial(OdAveMaterialImpl* pImpl);
  
  OdAveMaterialImpl* m_pImpl;
  friend class OdAveMaterialImpl;
};
 
class AVE_EXPORT OdAveGraniteMaterial : public OdAveMaterial
{
public:
  ODRX_DECLARE_MEMBERS(OdAveGraniteMaterial);
 
  enum GraniteColor
  {
    kFirst    = 0,
    kSecond   = 1,
    kThird    = 2,
    kFourth   = 3
  };
 
  virtual OdAve::MaterialType type();
 
  double colorFactor(GraniteColor graniteColor);
 
  OdUInt32 color(GraniteColor graniteColor);
 
  void setColorFactor(GraniteColor graniteColor, double colorFactor);
 
  void setColor(GraniteColor graniteColor, OdUInt32 color);
 
  double sharpness();
  void setSharpness(double sharpness);
 
  double scale();
  void setScale(double scale);
 
protected:
  OdAveGraniteMaterial();
  OdAveGraniteMaterial(OdAveMaterialImpl* pImpl);
};
typedef OdSmartPtr<OdAveGraniteMaterial> OdAveGraniteMaterialPtr;
 
class AVE_EXPORT OdAveMarbleMaterial : public OdAveMaterial
{
public:
  ODRX_DECLARE_MEMBERS(OdAveMarbleMaterial);
 
  virtual OdAve::MaterialType type();
 
  OdUInt32 stoneColor();
  OdUInt32 veinColor();
  
  void stoneColor(OdUInt32 color);
  
  void veinColor(OdUInt32 color);
 
  OdUInt32 turbulence();
  void setTurbulence(OdUInt32 turbulence);
 
  double sharpness();
  void setSharpness(double sharpness);
 
 
  double scale();
  
  void setScale(double scale);
 
protected:
  OdAveMarbleMaterial();
  OdAveMarbleMaterial(OdAveMaterialImpl* pImpl);
};
 
typedef OdSmartPtr<OdAveMarbleMaterial> OdAveMarbleMaterialPtr;
 
class AVE_EXPORT OdAveWoodMaterial : public OdAveMaterial
{
public:
  ODRX_DECLARE_MEMBERS(OdAveWoodMaterial);
 
  virtual OdAve::MaterialType type();
 
  OdUInt32 lightColor();
  OdUInt32 darkColor();
  void setLightColor(OdUInt32 lightColor);
  void setDarkColor(OdUInt32 darkColor);
 
  double lightDark();
  void setLightDark(double lightDark);
 
  double ringDensity();
  void setRingDensity(double ringDensity);
 
  double ringWidth();
  void setRingWidth(double ringWidth);
 
   double ringShape();
   void setRingShape(double ringShape) ;
 
  double scale();
  
  void setScale(double scale);
 
protected:
  OdAveWoodMaterial();
  OdAveWoodMaterial(OdAveMaterialImpl* pImpl);
};
 
typedef OdSmartPtr<OdAveWoodMaterial> OdAveWoodMaterialPtr;
 
AVE_EXPORT OdRxIteratorPtr oddbGetMaterials(OdDbDatabase* pDb);
 
AVE_EXPORT void oddbGetMaterialIds(OdDbDatabase* pDb, OdDbObjectIdArray& ids);
 
AVE_EXPORT OdRxIteratorPtr oddbGetMaterials(OdStreamBuf* pStreamBuf);
 
#include "TD_PackPop.h"
 
#endif // OD_AVEMATERIAL_H