HDK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
SIM_ElectricalProperties.h
Go to the documentation of this file.
1 /*
2  * Copyright (c) 2024
3  * Side Effects Software Inc. All rights reserved.
4  *
5  * Redistribution and use of Houdini Development Kit samples in source and
6  * binary forms, with or without modification, are permitted provided that the
7  * following conditions are met:
8  * 1. Redistributions of source code must retain the above copyright notice,
9  * this list of conditions and the following disclaimer.
10  * 2. The name of Side Effects Software may not be used to endorse or
11  * promote products derived from this software without specific prior
12  * written permission.
13  *
14  * THIS SOFTWARE IS PROVIDED BY SIDE EFFECTS SOFTWARE `AS IS' AND ANY EXPRESS
15  * OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
16  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN
17  * NO EVENT SHALL SIDE EFFECTS SOFTWARE BE LIABLE FOR ANY DIRECT, INDIRECT,
18  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
19  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA,
20  * OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
21  * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
22  * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
23  * EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
24  *
25  *----------------------------------------------------------------------------
26  */
27 
28 #ifndef __SIM_ElectricalProperties_h__
29 #define __SIM_ElectricalProperties_h__
30 
31 #include <SIM/SIM_Force.h>
32 #include <SIM/SIM_OptionsUser.h>
33 
34 #define HDK_NAME_RESISTANCE "resistance"
35 #define HDK_NAME_CAPACITANCE "capacitance"
36 #define HDK_NAME_INDUCTANCE "inductance"
37 
38 namespace HDK_Sample {
39 
40 /// This is an implementation of the SIM_Data interface. This
41 /// implementation contains fields to record electrical
42 /// properties.
44  public SIM_OptionsUser
45 {
46 public:
47  /// Controls the object's resistance.
49  /// Controls the object's capacitance.
51  /// Controls the object's inductance.
53 
54 protected:
55  explicit SIM_ElectricalProperties(const SIM_DataFactory *factory);
56  ~SIM_ElectricalProperties() override;
57 
58 private:
59  static const SIM_DopDescription *getElectricalPropertiesDopDescription();
60 
61  DECLARE_STANDARD_GETCASTTOTYPE();
62  DECLARE_DATAFACTORY(SIM_ElectricalProperties,
63  SIM_Data,
64  "Electrical Properties",
65  getElectricalPropertiesDopDescription());
66 };
67 
68 } // End HDK_Sample namespace
69 
70 #endif
#define HDK_NAME_INDUCTANCE
GETSET_DATA_FUNCS_F(HDK_NAME_RESISTANCE, Resistance)
Controls the object's resistance.
SIM_ElectricalProperties(const SIM_DataFactory *factory)
#define HDK_NAME_CAPACITANCE
#define HDK_NAME_RESISTANCE