SIM/SIM_ElectricalProperties.h

/*
 * Copyright (c) 2024
 *      Side Effects Software Inc.  All rights reserved.
 *
 * Redistribution and use of Houdini Development Kit samples in source and
 * binary forms, with or without modification, are permitted provided that the
 * following conditions are met:
 * 1. Redistributions of source code must retain the above copyright notice,
 *    this list of conditions and the following disclaimer.
 * 2. The name of Side Effects Software may not be used to endorse or
 *    promote products derived from this software without specific prior
 *    written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY SIDE EFFECTS SOFTWARE `AS IS' AND ANY EXPRESS
 * OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.  IN
 * NO EVENT SHALL SIDE EFFECTS SOFTWARE BE LIABLE FOR ANY DIRECT, INDIRECT,
 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA,
 * OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
 * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
 * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
 * EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 *
 *----------------------------------------------------------------------------
 */

#ifndef __SIM_ElectricalProperties_h__
#define __SIM_ElectricalProperties_h__

#include <SIM/SIM_Force.h>
#include <SIM/SIM_OptionsUser.h>

#define HDK_NAME_RESISTANCE     "resistance"
#define HDK_NAME_CAPACITANCE    "capacitance"
#define HDK_NAME_INDUCTANCE     "inductance"

namespace HDK_Sample {

/// This is an implementation of the SIM_Data interface. This
/// implementation contains fields to record electrical
/// properties.
class SIM_ElectricalProperties : public SIM_Data,
                                 public SIM_OptionsUser
{
public:
    /// Controls the object's resistance.
    GETSET_DATA_FUNCS_F(HDK_NAME_RESISTANCE, Resistance);
    /// Controls the object's capacitance.
    GETSET_DATA_FUNCS_F(HDK_NAME_CAPACITANCE, Capacitance);
    /// Controls the object's inductance.
    GETSET_DATA_FUNCS_F(HDK_NAME_INDUCTANCE, Inductance);

protected:
    explicit             SIM_ElectricalProperties(const SIM_DataFactory *factory);
                        ~SIM_ElectricalProperties() override;

private:
    static const SIM_DopDescription     *getElectricalPropertiesDopDescription();

    DECLARE_STANDARD_GETCASTTOTYPE();
    DECLARE_DATAFACTORY(SIM_ElectricalProperties,
                        SIM_Data,
                        "Electrical Properties",
                        getElectricalPropertiesDopDescription());
};

} // End HDK_Sample namespace

#endif