/**
 * @file  XTPChartRadarAxis.h
 *
 * @copyright
 * (c) 1998-2025 Codejock Software, All Rights Reserved.
 *
 * This source file is the property of Codejock Software and must not be
 * redistributed by any means without the explicit written permission of
 * Codejock Software.
 *
 * The use of this source code is governed by the terms and conditions specified
 * in the Toolkit Pro license agreement. Codejock Software grants you, as a
 * single software developer, the limited right to use this software on one
 * computer only.
 *
 * Contact Information:
 * support@codejock.com
 * http://www.codejock.com
 *
 */

/** @cond */
#if !defined(__XTPCHARTRADARAXIS_H__)
#	define __XTPCHARTRADARAXIS_H__
/** @endcond */

#	if _MSC_VER >= 1000
#		pragma once
#	endif // _MSC_VER >= 1000

#	include "Common/Base/Diagnostic/XTPDisableNoisyWarnings.h"

class CXTPChartRadarDiagram;

/**
 * @brief
 * CXTPChartRadarAxisX is a derived class from the CXTPChartAxis class
 * and represents the X axis of a chart.
 *
 * @details
 * It includes the features specific to the X axis of a chart.
 */
class _XTP_EXT_CLASS CXTPChartRadarAxisX : public CXTPChartAxis
{
	/** @cond */
	DECLARE_DYNAMIC(CXTPChartRadarAxisX)
	/** @endcond */
public:
	/**
	 * @brief
	 * Constructs a CXTPChartAxisX object.
	 *
	 * @param pDiagram Pointer to a CXTPChartRadarDiagram object.
	 */
	CXTPChartRadarAxisX(CXTPChartRadarDiagram* pDiagram);

public:
	/**
	 * @brief
	 * This method overrides the base class member and determines if
	 * the X axis is vertical.
	 *
	 * @return Returns TRUE if the X axis is vertical, FALSE if the X axis is not vertical.
	 */
	virtual BOOL IsVertical() const;

	/**
	 * @brief
	 * This method overrides the base class member and determines if
	 * the X axis is value type.
	 *
	 * @return Returns TRUE if the X axis is value type, FALSE if the X axis is not value type.
	 */
	virtual BOOL IsValuesAxis() const;

	/**
	 * @brief
	 * This method overrides the base class member and returns the
	 * side margin value of the chart's X axis.
	 *
	 * @param nMinValue The minimum value of the chart's X axis.
	 * @param nMaxValue The maximum value of the chart's X axis.
	 *
	 * @return Returns a double value that represents the margin.
	 */
	virtual double CalcSideMarginsValue(double nMinValue, double nMaxValue) const;

	/**
	 * @brief
	 * This function returns the direction of the axis.
	 *
	 * @return A BOOL value. TRUE if the direction of the axis is clockwise,
	 *		  FALSE if the direction of the axis is counterclockwise.
	 *
	 * @details
	 * TRUE/clockwise is the default value for the direction of the axis.
	 *
	 * @see
	 * SetDirectionClockwise
	 */
	BOOL IsDirectionClockwise() const;

	/**
	 * @brief
	 * This function sets the direction of the axis.
	 *
	 * @param bDirectionClockwise A new value for the axis direction.
	 *							 TRUE to set the direction of the axis to clockwise,
	 *							 FALSE to set the direction of the axis to counterclockwise.
	 *
	 * @details
	 * TRUE/clockwise is the default value for the direction of the axis.
	 *
	 * @see
	 * IsDirectionClockwise
	 */
	void SetDirectionClockwise(BOOL bDirectionClockwise);

protected:
	/**
	 * @brief
	 * This function creates the view (CXTPChartAxisView) of the axis.
	 *
	 * @param pDC The chart device context object pointer.
	 * @param pParentView The parent view of the axis.
	 *
	 * @return Returns a pointer to the newly created CXTPChartAxisView object.
	 */
	virtual CXTPChartAxisView* CreateView(CXTPChartDeviceContext* pDC,
										  CXTPChartElementView* pParentView);

	BOOL m_bDirectionClockwise; /**< The direction of the axis. Default is TRUE (clockwise).*/
};

/**
 * @brief
 * CXTPChartRadarAxisY is a derived class from the CXTPChartAxis class
 * and represents the Y axis of a chart.
 *
 * @details
 * It includes the features specific to the Y axis of a chart.
 */
class _XTP_EXT_CLASS CXTPChartRadarAxisY : public CXTPChartAxis
{
public:
	/**
	 * @brief
	 * Constructs a CXTPChartAxisY object.
	 *
	 * @param pDiagram Pointer to a CXTPChartRadarDiagram object.
	 */
	CXTPChartRadarAxisY(CXTPChartRadarDiagram* pDiagram);

public:
	/**
	 * @brief
	 * This method overrides the base class member and determines if
	 * the Y axis is vertical.
	 *
	 * @return Returns TRUE if the Y axis is vertical, FALSE if the Y axis is not vertical.
	 */
	virtual BOOL IsVertical() const;

	/**
	 * @brief
	 * This method overrides the base class member and determines if
	 * the Y axis is value type.
	 *
	 * @return Returns TRUE if the Y axis is value type, FALSE if the Y axis is not value type.
	 */
	virtual BOOL IsValuesAxis() const;

	/**
	 * @brief
	 * This method overrides the base class member and returns the
	 * side margin value of the chart's Y axis.
	 *
	 * @param nMinValue The minimum value of the chart's Y axis.
	 * @param nMaxValue The maximum value of the chart's Y axis.
	 *
	 * @return Returns a double value that represents the margin.
	 */
	virtual double CalcSideMarginsValue(double nMinValue, double nMaxValue) const;

protected:
	/**
	 * @brief
	 * This function creates the view (CXTPChartAxisView) of the axis.
	 *
	 * @param pDC The chart device context object pointer.
	 * @param pParentView The parent view of the axis.
	 *
	 * @return Returns a pointer to the newly created CXTPChartAxisView object.
	 */
	virtual CXTPChartAxisView* CreateView(CXTPChartDeviceContext* pDC,
										  CXTPChartElementView* pParentView);
};
/** @cond */
#	include "Common/Base/Diagnostic/XTPEnableNoisyWarnings.h"
#endif //#if !defined(__XTPCHARTRADARAXIS_H__)
	   /** @endcond */