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

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

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

class CXTPChartSeriesView;
class CXTPChartBorder;
class CXTPChartFillStyle;

/**
 * @brief
 * This class abstracts the basic style of a pyramid series. This class is a kind of
 * CXTPChartSeriesStyle.
 *
 * @details
 * A pyramid chart (or a circle graph) is a circular chart divided into sectors,
 * illustrating percents. In a pyramid chart, the arc length of each sector (and
 * consequently its central angle and area), is proportional to the quantity
 * it represents. Together, the sectors create a full disk.
 */
class _XTP_EXT_CLASS CXTPChart3dPyramidSeriesStyle : public CXTPChartPyramidSeriesStyleBase
{
	DECLARE_SERIAL(CXTPChart3dPyramidSeriesStyle);

public:
	/**
	 * @brief
	 * Constructs a CXTPChart3dPyramidSeriesStyle object.
	 */
	CXTPChart3dPyramidSeriesStyle();

	/**
	 * @brief
	 * Call this function to create the pyramid diagram object.
	 *
	 * @return
	 * Returns a pointer to the associated diagram object.
	 */
	virtual CXTPChartDiagram* CreateDiagram();

	/**
	 * @brief
	 * Call this function to create the view of the pyramid series.
	 *
	 * @param pSeries       A pointer to the chart series object.
	 * @param pDiagramView  A pointer to the diagram view object.
	 *
	 * @return
	 * Returns a pointer to the associated series view object.
	 */
	virtual CXTPChartSeriesView* CreateView(CXTPChartSeries* pSeries,
											CXTPChartDiagramView* pDiagramView);

	/**
	 * @brief
	 * Call this function to check whether a chart diagram object passed
	 * is a kind of CXTPChart3dPyramidDiagramBase/CXTPChart3dPyramidDiagramBase.
	 *
	 * @param pDiagram A pointer to a chart diagram, whose type is to be identified.
	 *
	 * @return
	 * TRUE if the chart diagram is a pyramid diagram, FALSE otherwise.
	 */
	virtual BOOL IsStyleDiagram(CXTPChartDiagram* pDiagram) const;

	/**
	 * @brief
	 * Call this member function to Store/Load an event using the
	 * specified data object.
	 *
	 * @param pPX Source or destination CXTPPropExchange data object reference.
	 *
	 * @details
	 * This member function is used to store event data to or load event
	 * data from storage.
	 */
	virtual void DoPropExchange(CXTPPropExchange* pPX);

	/**
	 * @brief
	 * Gets the number of base edges for the pyramid. The number of
	 * edges must not be equal to 1 or 2. If 0 is used as edge count the
	 * round pyramid (with no edges) will be drawn.
	 *
	 * @return
	 * Current number of base edges.
	 */
	int GetBaseEdgeCount() const;

	/**
	 * @brief
	 * Sets the number of base edges for the pyramid. The number of
	 * edges must not be equal to 1 or 2. If 0 is used as edge count the
	 * round pyramid (with no edges) will be drawn.
	 *
	 * @param nEdgeCount A new number of base edges.
	 */
	void SetBaseEdgeCount(int nEdgeCount);

	/** @cond */

	_XTP_DEPRECATED_IN_FAVOR(Is3dEdgeSmoothingEnabled)
	BOOL IsEdgeSmoothingEnabled() const
	{
		return Is3dEdgeSmoothingEnabled();
	}

	_XTP_DEPRECATED_IN_FAVOR(Enable3dEdgeSmoothing)
	void EnableEdgeSmoothing(BOOL bEnable = TRUE)
	{
		Enable3dEdgeSmoothing(bEnable);
	}

#	ifdef _XTP_ACTIVEX
public:
	DECLARE_DISPATCH_MAP()
	DECLARE_INTERFACE_MAP()
	DECLARE_OLETYPELIB_EX(CXTPChart3dPyramidSeriesStyle);
	DECLARE_OLECREATE_EX(CXTPChart3dPyramidSeriesStyle)
#	endif
	/** @endcond */

private:
	int m_nBaseEdgeCount;
};

AFX_INLINE int CXTPChart3dPyramidSeriesStyle::GetBaseEdgeCount() const
{
	return m_nBaseEdgeCount;
}
/** @cond */
#	include "Common/Base/Diagnostic/XTPEnableNoisyWarnings.h"
#endif //#if !defined(__XTPCHART3DPYRAMIDSERIESSTYLE_H__)
	   /** @endcond */