File Scan3DParameters.h¶

File List > include > Scan3DParameters.h
//=============================================================================
// Copyright (c) 2026 FLIR Integrated Imaging Solutions, Inc. All Rights Reserved.
//
// This software is the confidential and proprietary information of FLIR
// Integrated Imaging Solutions, Inc. ("Confidential Information"). You
// shall not disclose such Confidential Information and shall use it only in
// accordance with the terms of the license agreement you entered into
// with FLIR Integrated Imaging Solutions, Inc. (FLIR).
//
// FLIR MAKES NO REPRESENTATIONS OR WARRANTIES ABOUT THE SUITABILITY OF THE
// SOFTWARE, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE
// IMPLIED WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR
// PURPOSE, OR NON-INFRINGEMENT. FLIR SHALL NOT BE LIABLE FOR ANY DAMAGES
// SUFFERED BY LICENSEE AS A RESULT OF USING, MODIFYING OR DISTRIBUTING
// THIS SOFTWARE OR ITS DERIVATIVES.
//=============================================================================

/* Auto-generated file. Do not modify. */

#ifndef FLIR_SPINNAKER_SCAN3DPARAMETERS_H
#define FLIR_SPINNAKER_SCAN3DPARAMETERS_H

#include "Interface/IScan3DParameters.h"
#include <map>

namespace Spinnaker
{
    struct SPINNAKER_API CoordinateDependentParams
    {
        float64_t invalidDataValue;   
        float64_t coordinateOffset;    
        float64_t coordinateScale;     
        bool invalidDataFlag;          
        float64_t axisMin;            
        float64_t axisMax;            
    };

    class SPINNAKER_API Scan3DParameters: public IScan3DParameters
    {
    public:
        Scan3DParameters();

        Scan3DParameters(GenApi::INodeMap & nodeMap);

        Scan3DParameters(const Scan3DParameters& src);

        virtual ~Scan3DParameters(void);

        Scan3DParameters& operator=(const Scan3DParameters& scan);

        void SetScan3DParameters(GenApi::INodeMap & pNodeMap);

        float64_t GetFocalLength() const;

        float64_t GetBaseline() const;

        float64_t GetPrincipalPointU() const;

        float64_t GetPrincipalPointV() const;

        Scan3dDistanceUnitEnums GetDistanceUnit() const;

        Scan3dCoordinateSystemEnums GetCoordinateSystem() const;

        Scan3dOutputModeEnums GetOutputMode() const;

        Scan3dCoordinateSystemReferenceEnums GetCoordinateSystemReference() const;

        Scan3dCoordinateSelectorEnums GetCoordinateSelector() const;

        Scan3dCoordinateTransformSelectorEnums GetCoordinateTransformSelector() const;

        float64_t GetTransformValue() const;

        Scan3dCoordinateReferenceSelectorEnums GetCoordinateReferenceSelector() const;

        float64_t GetCoordinateReferenceValue() const;

        void SetFocalLength(float64_t value);

        void SetBaseline(float64_t value);

        void SetPrincipalPointU(float64_t value);

        void SetPrincipalPointV(float64_t value);

        void SetDistanceUnit(Scan3dDistanceUnitEnums value);

        void SetCoordinateSystem(Scan3dCoordinateSystemEnums value);

        void SetOutputMode(Scan3dOutputModeEnums value);

        void SetCoordinateSystemReference(Scan3dCoordinateSystemReferenceEnums value);

        void SetCoordinateSelector(Scan3dCoordinateSelectorEnums value);

        void SetCoordinateTransformSelector(Scan3dCoordinateTransformSelectorEnums value);

        void SetTransformValue(float64_t value);

        void SetCoordinateReferenceSelector(Scan3dCoordinateReferenceSelectorEnums value);

        void SetCoordinateReferenceValue(float64_t value);

        float64_t GetInvalidDataValue(Scan3dCoordinateSelectorEnums coordinate = Scan3dCoordinateSelector_CoordinateC) const;

        float64_t GetCoordinateOffset(Scan3dCoordinateSelectorEnums coordinate = Scan3dCoordinateSelector_CoordinateC) const;

        bool GetInvalidDataFlag(Scan3dCoordinateSelectorEnums coordinate = Scan3dCoordinateSelector_CoordinateC) const;

        float64_t GetCoordinateScale(Scan3dCoordinateSelectorEnums coordinate = Scan3dCoordinateSelector_CoordinateC) const;

        float64_t GetAxisMin(Scan3dCoordinateSelectorEnums coordinate = Scan3dCoordinateSelector_CoordinateC) const;

        float64_t GetAxisMax(Scan3dCoordinateSelectorEnums coordinate = Scan3dCoordinateSelector_CoordinateC) const;

        void SetInvalidDataValue(float64_t value, Scan3dCoordinateSelectorEnums coordinate = Scan3dCoordinateSelector_CoordinateC);

        void SetCoordinateOffset(float64_t value, Scan3dCoordinateSelectorEnums coordinate = Scan3dCoordinateSelector_CoordinateC);

        void SetInvalidDataFlag(bool value, Scan3dCoordinateSelectorEnums coordinate = Scan3dCoordinateSelector_CoordinateC);

        void SetCoordinateScale(float64_t value, Scan3dCoordinateSelectorEnums coordinate = Scan3dCoordinateSelector_CoordinateC);

        void SetAxisMin(float64_t value, Scan3dCoordinateSelectorEnums coordinate = Scan3dCoordinateSelector_CoordinateC);

        void SetAxisMax(float64_t value, Scan3dCoordinateSelectorEnums coordinate = Scan3dCoordinateSelector_CoordinateC);

        CoordinateDependentParams GetCoordinateParams(Scan3dCoordinateSelectorEnums coordinate = Scan3dCoordinateSelector_CoordinateC) const;

        void SetCoordinateParams(const CoordinateDependentParams& params, Scan3dCoordinateSelectorEnums coordinate = Scan3dCoordinateSelector_CoordinateC);

        std::map<Scan3dCoordinateSelectorEnums, CoordinateDependentParams> GetAllCoordinateParams() const;

        void SetAllCoordinateParams(const std::map<Scan3dCoordinateSelectorEnums, CoordinateDependentParams>& params);

        StereoCameraParameters ToStereoCameraParameters() const;

        void FromStereoCameraParameters(const StereoCameraParameters& params);

        friend class Scan3DParametersImpl;

    };
}
#endif // FLIR_SPINNAKER_SCAN3D_H