///////////////////////////////////////////////////////////////////////////////
// Copyright (C) 2002-2025, 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-2025 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 _PRCSRFTRANSFORM_INCLUDED_
#define _PRCSRFTRANSFORM_INCLUDED_ 
 

#include "PrcSurface.h"
#include "PrcMath3d.h"

/** \details 
The class that represents a surface that is defined by a 3D mathematical transformation applied to a base surface.
<group PRC_Surface_Classes>
*/
class PRC_TOOLKIT OdPrcTransformedSurface : public OdPrcSurface
{
public:
  ODPRC_DECLARE_MEMBERS_SURF(OdPrcTransformedSurface)

  /** \details
  Destroys the transformed surface object.
  */
  ~OdPrcTransformedSurface();
  
  /** \details
  Requests the current 3D mathematical transformation of the transformed surface.
  \returns A smart pointer to the <link OdPrcMath3d, OdPrcMath3d> object that represents the current surface transformation.
  The 3D mathematical transformation is returned as a reference to an <link OdPrcMath3dPtr, OdPrcMath3dPtr> object; 
  therefore, it can be used to set a new transformation.
  */
  OdPrcMath3dPtr &mathTransformation();
  
  /** \details
  Requests the current 3D mathematical transformation of the transformed surface.
  \returns A smart pointer to the <link OdPrcMath3d, OdPrcMath3d> object that represents the current surface transformation.
  */
  const OdPrcMath3dPtr &mathTransformation() const;
  
  /** \details
  Sets a new base surface.

  \param value [in] A pointer to a new base <link OdPrcSurface, surface> to be set.
  
  \returns The eOk value if a new base surface was successfully applied to the transformed surface or an appropriate error code in the other case.
  */
  OdResult setBaseSurface(const OdPrcSurfacePtr &value);
  
  /** \details
  Requests the current base surface.
  \returns A smart pointer to the <link OdPrcSurface, OdPrcSurface> object that represents the base surface.
  */
  const OdPrcSurfacePtr &baseSurface() const;
};

SMARTPTR(OdPrcTransformedSurface);

#endif // _PRCSRFTRANSFORM_INCLUDED_