Resources/PhpOffice/PhpPresentation/Shape/Chart/View3D.php

<?php
/**
 * This file is part of PHPPresentation - A pure PHP library for reading and writing
 * presentations documents.
 *
 * PHPPresentation is free software distributed under the terms of the GNU Lesser
 * General Public License version 3 as published by the Free Software Foundation.
 *
 * For the full copyright and license information, please read the LICENSE
 * file that was distributed with this source code. For the full list of
 * contributors, visit https://github.com/PHPOffice/PHPPresentation/contributors.
 *
 * @see        https://github.com/PHPOffice/PHPPresentation
 *
 * @copyright   2009-2015 PHPPresentation contributors
 * @license     http://www.gnu.org/licenses/lgpl.txt LGPL version 3
 */

declare(strict_types=1);

namespace PhpOffice\PhpPresentation\Shape\Chart;

use PhpOffice\PhpPresentation\ComparableInterface;

/**
 * \PhpOffice\PhpPresentation\Shape\Chart\View3D.
 */
class View3D implements ComparableInterface
{
    /**
     * Rotation X.
     *
     * @var int
     */
    protected $rotationX = 0;

    /**
     * Rotation Y.
     *
     * @var int
     */
    protected $rotationY = 0;

    /**
     * Right Angle Axes.
     *
     * @var bool
     */
    private $rightAngleAxes = true;

    /**
     * Perspective.
     *
     * @var int
     */
    private $perspective = 30;

    /**
     * Height Percent.
     *
     * @var int|null
     */
    private $heightPercent = 100;

    /**
     * Depth Percent.
     *
     * @var int
     */
    private $depthPercent = 100;

    /**
     * Hash index.
     *
     * @var int
     */
    private $hashIndex;

    /**
     * Create a new \PhpOffice\PhpPresentation\Shape\Chart\View3D instance.
     */
    public function __construct()
    {
    }

    /**
     * Get Rotation X.
     *
     * @return int
     */
    public function getRotationX()
    {
        return $this->rotationX;
    }

    /**
     * Set Rotation X (-90 to 90).
     *
     * @param int $pValue
     *
     * @return \PhpOffice\PhpPresentation\Shape\Chart\View3D
     */
    public function setRotationX($pValue = 0)
    {
        $this->rotationX = $pValue;

        return $this;
    }

    /**
     * Get Rotation Y.
     *
     * @return int
     */
    public function getRotationY()
    {
        return $this->rotationY;
    }

    /**
     * Set Rotation Y (-90 to 90).
     *
     * @param int $pValue
     *
     * @return \PhpOffice\PhpPresentation\Shape\Chart\View3D
     */
    public function setRotationY($pValue = 0)
    {
        $this->rotationY = $pValue;

        return $this;
    }

    /**
     * Get RightAngleAxes.
     *
     * @return bool
     */
    public function hasRightAngleAxes()
    {
        return $this->rightAngleAxes;
    }

    /**
     * Set RightAngleAxes.
     *
     * @param bool $value
     *
     * @return \PhpOffice\PhpPresentation\Shape\Chart\View3D
     */
    public function setRightAngleAxes($value = true)
    {
        $this->rightAngleAxes = $value;

        return $this;
    }

    /**
     * Get Perspective.
     *
     * @return int
     */
    public function getPerspective()
    {
        return $this->perspective;
    }

    /**
     * Set Perspective (0 to 100).
     *
     * @param int $value
     *
     * @return \PhpOffice\PhpPresentation\Shape\Chart\View3D
     */
    public function setPerspective($value = 30)
    {
        $this->perspective = $value;

        return $this;
    }

    /**
     * Get HeightPercent.
     *
     * @return int
     */
    public function getHeightPercent()
    {
        return $this->heightPercent;
    }

    /**
     * Set HeightPercent (5 to 500).
     */
    public function setHeightPercent(?int $value = 100): self
    {
        $this->heightPercent = $value;

        return $this;
    }

    /**
     * Get DepthPercent.
     */
    public function getDepthPercent(): ?int
    {
        return $this->depthPercent;
    }

    /**
     * Set DepthPercent (20 to 2000).
     *
     * @param int $value
     *
     * @return $this
     */
    public function setDepthPercent($value = 100)
    {
        $this->depthPercent = $value;

        return $this;
    }

    /**
     * Get hash code.
     *
     * @return string Hash code
     */
    public function getHashCode(): string
    {
        return \md5($this->rotationX . $this->rotationY . ($this->rightAngleAxes ? 't' : 'f') . $this->perspective . $this->heightPercent . $this->depthPercent . __CLASS__);
    }

    /**
     * Get hash index.
     *
     * Note that this index may vary during script execution! Only reliable moment is
     * while doing a write of a workbook and when changes are not allowed.
     *
     * @return int|null Hash index
     */
    public function getHashIndex(): ?int
    {
        return $this->hashIndex;
    }

    /**
     * Set hash index.
     *
     * Note that this index may vary during script execution! Only reliable moment is
     * while doing a write of a workbook and when changes are not allowed.
     *
     * @param int $value Hash index
     *
     * @return View3D
     */
    public function setHashIndex(int $value)
    {
        $this->hashIndex = $value;

        return $this;
    }
}