HDK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
SIM_OptionsUser Class Reference

#include <SIM_OptionsUser.h>

Inherited by GAS_SubSolver, HDK_Sample::SIM_ElectricalProperties, HDK_Sample::SIM_ForceOrbit, HDK_Sample::SIM_SolverHair, HDK_Sample::SNOW_Solver, HDK_Sample::SNOW_Visualize, RBD_Solver, RBD_SphereEdgeTree, RBD_SpherePointTree, SIM_ActiveValue, SIM_BlendFactor, SIM_Collider, SIM_ColliderLabel, SIM_ConAnchor, SIM_ConRelHard, SIM_ConRelSoftAttach, SIM_ConRelSpring, SIM_ConRelTwoState, SIM_ConstraintNetworkRelationship, SIM_ConstraintNetworkVisualization, SIM_EmptyData, SIM_ForceBuoyancy, SIM_ForceDrag, SIM_ForceFan, SIM_ForceField, SIM_ForceGravity, SIM_ForceImpulse, SIM_ForceMagnet, SIM_ForcePoint, SIM_ForceReferenceFrame, SIM_ForceUniform, SIM_ForceVelImpulse, SIM_ForceVex, SIM_ForceVortex, SIM_Geometry, SIM_IndexField, SIM_IndexFieldVisualization, SIM_MatrixField, SIM_MatrixFieldVisualization, SIM_Noise, SIM_ParticleFieldVisualization, SIM_PhysicalParms, SIM_PointMapping, SIM_POPShapeMatch, SIM_PositionComposite, SIM_PositionSimple, SIM_RelationshipCollide, SIM_RenderParms, SIM_RestPropertiesBase, SIM_ScalarField, SIM_ScalarFieldVisualization, SIM_SDF, SIM_SlicePlane, SIM_SolverBlend, SIM_SolverCopy, SIM_SolverMulti, SIM_SolverPop, SIM_SolverScript, SIM_SolverSop, SIM_SolverSwitch, SIM_SopGuide, SIM_SurfaceCollisionParms, SIM_SwitchValue, SIM_TargetPropertiesBase, SIM_VectorField, SIM_VectorFieldVisualization, and SIM_VoronoiFractureParms.

Public Member Functions

 SIM_OptionsUser (SIM_Data *owner)
 
virtual ~SIM_OptionsUser ()
 
void optionChanged (const char *name)
 
const SIM_OptionsgetOptions () const
 

Protected Member Functions

SIM_OptionsgetOptions ()
 
virtual void optionChangedSubclass (const char *name)
 

Detailed Description

This class can be included as a base class of any SIM_Data subclass. Doing so provides an easy way to establish and store a set of simple values that define that data type. The macros at the end of this file make it easy to create get and set access functions for this data.

Examples:
SIM/SIM_ElectricalProperties.C, SIM/SIM_ElectricalProperties.h, SIM/SIM_ForceOrbit.C, SIM/SIM_ForceOrbit.h, SIM/SIM_SolverHair.C, SIM/SIM_SolverHair.h, SIM/SNOW_Solver.C, and SIM/SNOW_Solver.h.

Definition at line 23 of file SIM_OptionsUser.h.

Constructor & Destructor Documentation

SIM_OptionsUser::SIM_OptionsUser ( SIM_Data owner)
virtual SIM_OptionsUser::~SIM_OptionsUser ( )
virtual

Member Function Documentation

const SIM_Options& SIM_OptionsUser::getOptions ( ) const
SIM_Options& SIM_OptionsUser::getOptions ( )
protected
void SIM_OptionsUser::optionChanged ( const char *  name)

This callback function that is run by SIM_Options::optionChanged(). It calls the virtual optionChangedSubclass().

virtual void SIM_OptionsUser::optionChangedSubclass ( const char *  name)
protectedvirtual

The documentation for this class was generated from the following file: