AveLight.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.
 
 
 
#ifndef OD_AVELIGHT_H
#define OD_AVELIGHT_H
 
#include "TD_PackPush.h"
 
#include "RxObject.h"
#include "DbObjectId.h"
#include "IdArrays.h"
#include "Ve/AveDefs.h"
#include "Gs/GsLight.h"
 
class OdGePoint3d;
class OdGeVector3d;
 
class OdAveLightImpl;
class OdAveLight;
typedef OdSmartPtr<OdAveLight> OdAveLightPtr;
 

class AVE_EXPORT OdAveLight : public OdGsLight
{
public:
  ODRX_DECLARE_MEMBERS(OdAveLight);

  static OdAveLightPtr getLight(const OdDbObjectId& blockRefId);
  static OdString getLightName(const OdDbObjectId& blockRefId);

  OdResult writeLight(OdDbDatabase* pDb = 0, const OdDbHandle& holderHandle = 0, const OdDbObjectId& ownerId = OdDbObjectId::kNull);

  OdGsLight::LightType type() const;
  void setType(OdGsLight::LightType type);

  OdString name() const;
  
  void setName(const OdString& name);

  double intensity() const;
  void setIntensity(double intensity);

  OdUInt32 color() const;
  
  void setColor(OdUInt32 color);

  OdGePoint3d position() const;
  
  OdGePoint3d target() const;

  OdGeVector3d direction() const;
  
  void setPosition(const OdGePoint3d& position);
 
  void setTarget(const OdGePoint3d& target);
  void setDirection(const OdGePoint3d& fromPoint, const OdGePoint3d& toPoint);

  OdGsLight::LightAttenuation attenuation() const;
  
  void setAttenuation(OdGsLight::LightAttenuation attenuation);

  
  double innerConeAngle() const;
  double outerConeAngle() const;
  
  void setConeAngle(double innerConeAngle, double outerConeAngle);

  bool isShadowOn() const;
  void setShadowOn(bool shadowOn);

  bool isShadowVolumes() const;
  void setShadowVolumes(bool);

  OdInt16 shadowMapSize() const;

  void shadowMapSize(OdInt16 mapSize);

  double shadowSoftness() const;
  void setShadowSoftness(double shadowSoftness);

  void shadowBoundingObjects(OdDbObjectIdArray& objectIds) const;
  void setShadowBoundingObjects(const OdDbObjectIdArray& objectIds);
  void addShadowBoundingObject(const OdDbObjectId& objectId);

  OdDbObjectId holderId() const;
 
protected:
  OdAveLight();
  OdAveLight(OdAveLightImpl* pImpl);
  
  OdAveLightImpl* m_pImpl;
};

AVE_EXPORT OdRxIteratorPtr oddbGetLights(OdDbDatabase* pDb);
 
#include "TD_PackPop.h"
 
#endif // OD_AVELIGHT_H