/////////////////////////////////////////////////////////////////////////////// 
// 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 __TNW_TEXTURE_SPACE_CYLINDER_H__
#define __TNW_TEXTURE_SPACE_CYLINDER_H__

#include "NwTextureSpace.h"
#include "NwAxisDirection.h"

class OdGeVector3d;
class OdGeVector3d;
class OdGeQuaternion;
class OdGeExtents3d;

/** \details
  Axis directions of uv plane.
*/
typedef std::pair<NwAxisDirection::Enum, NwAxisDirection::Enum> OdNwUVPlane;

/** \details
  This class represents a texture space mapping by cylindrical surfaces or the cylindre 'caps' planes.

  <group OdNw_Classes>
*/
class NWDBEXPORT OdNwTextureSpaceCylinder : public OdNwTextureSpace
{
  //DOM-IGNORE-BEGIN
  ODRX_DECLARE_MEMBERS(OdNwTextureSpaceCylinder);
  //DOM-IGNORE-END

public:
  /** \details
    Default constructor. Creates an object of the OdNwTextureSpaceCylinder class.
  */
  OdNwTextureSpaceCylinder();

public:
  /** \details
    Virtual destructor. Frees allocated resources.
  */
  virtual ~OdNwTextureSpaceCylinder();

public:
  /** \details
    Gets the translation of space mapping.

    \returns OdGeVector3d object with the space mapping translation.
  */
  OdGeVector3d getTranslation() const;

  /** \details
    Gets the space mapping's scaling.

    \returns OdGeVector3d object with the mapping's scaling.
  */
  OdGeVector3d getScale() const;

  /** \details
    Gets the rotation of space mapping.

    \returns OdGeQuaternion object with the space mapping rotation.
  */
  OdGeQuaternion getRotation() const;

  /** \details
    Gets the domain extents of space mapping.

    \returns OdGeExtents3d object the domain extents of space mapping.
  */
  OdGeExtents3d getDomainExts() const;

  /** \details
    Indicates whether a cylinder 'caps' enabled or not.

    \returns The true value if a cylinder cap enabled, or returns false otherwise.
  */
  bool isEnabledCap() const;

  /** \details
    Gets the cap threshold angle.

    \returns radian value of 'caps' threshold angle.
  */
  double getCapThreshold() const;

  /** \details
    Gets the mapping top cap's plane.

    \returns pair with NwAxisDirection::Enum values of uv direction of plane.

    \remarks
    first and second element of return value can be one of the following:
    <table>
    Name                                      Value   Description
    NwAxisDirection::kXPositive               0x00    Positive X axis direction.
    NwAxisDirection::kXNegative               0x01    Negative Y axis direction.
    NwAxisDirection::kYPositive               0x02    Positive Y axis direction.
    NwAxisDirection::kYNegative               0x03    Negative Y axis direction.
    </table>
  */
  OdNwUVPlane getTopUV() const;

  /** \details
    Gets the mapping bottom cap's plane.

    \returns pair with NwAxisDirection::Enum values of uv direction of plane.

    \remarks
    first and second element of return value can be one of the following:
    <table>
    Name                                      Value   Description
    NwAxisDirection::kXPositive               0x00    Positive X axis direction.
    NwAxisDirection::kXNegative               0x01    Negative Y axis direction.
    NwAxisDirection::kYPositive               0x02    Positive Y axis direction.
    NwAxisDirection::kYNegative               0x03    Negative Y axis direction.
    </table>
  */
  OdNwUVPlane getBottomUV() const;
};

/** \details
  This template class is a specialization of the OdSmartPtr class for OdNwTextureSpaceCylinder object pointers.
*/
typedef OdSmartPtr<OdNwTextureSpaceCylinder> OdNwTextureSpaceCylinderPtr;

#endif //__TNW_TEXTURE_SPACE_CYLINDER_H__