/**
 * @file  XTPChartPyramidSeriesPointViewBase.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(__XTPCHARTPYRAMIDSERIESPOINTVIEWBASE_H__)
#	define __XTPCHARTPYRAMIDSERIESPOINTVIEWBASE_H__
/** @endcond */

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

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

class CXTPChartSeriesPoint;
class CXTPChartElementView;
class CXTPChartDeviceCommand;
class CXTPChartDeviceContext;
class CXTPChartPyramidSeriesViewBase;
class CXTPChartPyramidSeriesView;
class CXTPChart3dPyramidSeriesPointView;

/**
 * @brief
 * This class abstracts the view of a pyramid series point.
 */
class _XTP_EXT_CLASS CXTPChartPyramidSeriesPointViewBase : public CXTPChartSeriesPointView
{
	DECLARE_DYNAMIC(CXTPChartPyramidSeriesPointViewBase);

public:
	/**
	 * @brief
	 * Constructs a CXTPChartPyramidSeriesPointViewBase object.
	 *
	 * @param pPoint        Pointer to the chart series point.
	 * @param pParentView   Parent element view pointer.
	 */
	CXTPChartPyramidSeriesPointViewBase(CXTPChartSeriesPoint* pPoint,
										CXTPChartElementView* pParentView);

	/**
	 * @brief
	 * Constructs a CXTPChartPyramidSeriesPointViewBase object.
	 *
	 * @param pPoint        Pointer to the chart series point.
	 * @param pParentView   Parent element view pointer.
	 * @param bAddToParent  If TRUE the view will be be added to parent's child view list.
	 */
	CXTPChartPyramidSeriesPointViewBase(CXTPChartSeriesPoint* pPoint,
										CXTPChartElementView* pParentView, BOOL bAddToParent);

	/**
	 * @brief
	 * Destroys a CXTPChartPyramidSeriesPointViewBase object, handles cleanup.
	 */
	virtual ~CXTPChartPyramidSeriesPointViewBase();

	/**
	 * @brief
	 * Use this function to calculate the layout of the pyramid series point.
	 *
	 * @param nIndex Point index.
	 * @param nCount Total number of points.
	 * @param dFrom The percentage factor value in the range 0..1 of the inital pyramid point value.
	 * @param dTo The percentage factor value in the range 0..1 of the final pyramid point value.
	 */
	virtual void CalculateLayout(int nIndex, int nCount, double dFrom, double dTo) = 0;

	/**
	 * @brief
	 * Use this function to obtain the color value of the pyramid border.
	 *
	 * @return
	 * Border color value.
	 */
	CXTPChartColor GetBorderActualColor() const;

protected:
	/**
	 * @brief
	 * This function creates a CXTPChartDeviceCommand object. This object
	 * represents the rendering of the pyramid series point.
	 *
	 * @param pDC      Pointer to a CXTPChartDeviceContext object.
	 *
	 * @return
	 * Returns a CXTPChartDeviceCommand object. This object handles
	 * the rendering of an element in the chart. Here it handles
	 * the drawing of the pyramid series point.
	 */
	virtual CXTPChartDeviceCommand* CreateDeviceCommand(CXTPChartDeviceContext* pDC) = 0;

	/**
	 * @brief
	 * This function creates a label view drawing command object.
	 *
	 * @param pDC      Pointer to a CXTPChartDeviceContext object.
	 * @param rcBounds The rectangular boundary of the legend.
	 *
	 * @return
	 * Returns a new label view drawing command object.
	 */
	virtual CXTPChartDeviceCommand* CreateLegendDeviceCommand(CXTPChartDeviceContext* pDC,
															  CRect rcBounds);

protected:
	double m_dValue; /**< The value of the point.*/

	friend class CXTPChartPyramidSeriesViewBase;
	friend class CXTPChartPyramidSeriesView;
	friend class CXTPChart3dPyramidSeriesView;
	friend class CXTPChart3dPyramidSeriesPointView;
};
/** @cond */
#	include "Common/Base/Diagnostic/XTPEnableNoisyWarnings.h"
#endif //#if !defined(__XTPCHARTPYRAMIDSERIESPOINTVIEWBASE_H__)
	   /** @endcond */