IECore::Parameterised Class Reference

#include <Parameterised.h>

Inheritance diagram for IECore::Parameterised:

IECore::RunTimeTyped IECore::ParameterisedInterface IECore::RefCounted IECore::Converter IECore::Op IECore::Preset::Preset IECore::FromCoreConverter IECore::ToCoreConverter IECore::CheckFileDependenciesOp::CheckFileDependenciesOp IECore::ClassLsOp::ClassLsOp IECore::CurveExtrudeOp IECore::CurveTracer IECore::DataCastOp IECore::DataPromoteOp IECore::EnvMapSampler IECore::EnvMapSHProjector IECore::FileDependenciesOp::FileDependenciesOp IECore::FileSequenceAnalyzerOp::FileSequenceAnalyzerOp IECore::HdrMergeOp IECore::ImageDiffOp IECore::LsHeaderOp::LsHeaderOp IECore::MarschnerLookupTableOp IECore::MedianCutSampler IECore::ModifyOp IECore::ParticleMeshOp IECore::PointBoundsOp IECore::PointDensitiesOp IECore::PointMeshOp IECore::PointNormalsOp IECore::PointsMotionOp IECore::RandomRotationOp IECore::Reader IECore::SearchReplaceOp::SearchReplaceOp IECore::SequenceCatOp::SequenceCatOp IECore::SequenceConvertOp::SequenceConvertOp IECore::SequenceCpOp::SequenceCpOp IECore::SequenceLsOp::SequenceLsOp IECore::SequenceMergeOp::SequenceMergeOp IECore::SequenceMvOp::SequenceMvOp IECore::SequenceRenumberOp::SequenceRenumberOp IECore::SequenceRmOp::SequenceRmOp IECore::SplineToImage IECore::UniformRandomPointDistributionOp IECore::Writer IECoreMaya::BakeTransform::BakeTransform IECoreRI::MakeRibOp::MakeRibOp

List of all members.

Public Member Functions

 IE_CORE_DECLARERUNTIMETYPED (Parameterised, RunTimeTyped)
 Parameterised (const std::string &description)
 Parameterised (const std::string &description, CompoundParameterPtr compoundParameter)
 Another constructor added later on that gives defines the CompoundParameter object to be hold in this Parameterised instance.
virtual ~Parameterised ()
const std::string & description () const
 Returns a description for this parameterised object.
virtual CompoundParameterPtr parameters ()
virtual ConstCompoundParameterPtr parameters () const
 Returns the parameters for query.
CompoundObjectPtr userData ()
 Returns an object that anyone can use for storing anything.
ConstCompoundObjectPtr userData () const
 Read only version of the above.

Detailed Description

The Parameterised class provides a useful base class for all classes wishing to implement both RunTimeTyped and ParameterisedInterface.

Constructor & Destructor Documentation

Parameterised::Parameterised ( const std::string &  description  ) 

The base class constructor receives the name and a short description about the Parameterised object created. They are usually defined within the derived class constructors.

Parameterised::Parameterised ( const std::string &  description,
CompoundParameterPtr  compoundParameter 
)

Another constructor added later on that gives defines the CompoundParameter object to be hold in this Parameterised instance.

Parameterised::~Parameterised (  )  [virtual]

Member Function Documentation

const std::string & Parameterised::description (  )  const

Returns a description for this parameterised object.

IECore::Parameterised::IE_CORE_DECLARERUNTIMETYPED ( Parameterised  ,
RunTimeTyped   
)

ConstCompoundParameterPtr Parameterised::parameters (  )  const [virtual]

Returns the parameters for query.

Implements IECore::ParameterisedInterface.

CompoundParameterPtr Parameterised::parameters (  )  [virtual]

Returns the parameters for editing. Subclasses should typically add parameters to this from their constructors.

Implements IECore::ParameterisedInterface.

Referenced by IECore::AddSmoothSkinningInfluencesOp::AddSmoothSkinningInfluencesOp(), IECore::CurveTracer::catmullRomStepParameter(), IECore::CurveTracer::channelNameParameter(), IECore::ColorTransformOp::ColorTransformOp(), IECore::EXRImageWriter::compressionParameter(), IECore::CompressSmoothSkinningDataOp::CompressSmoothSkinningDataOp(), IECore::UniformRandomPointDistributionOp::constructCommon(), IECore::ContrastSmoothSkinningWeightsOp::ContrastSmoothSkinningWeightsOp(), IECoreMaya::ToMayaObjectConverter::convert(), IECoreGL::ToGLConverter::convert(), IECore::ToCoreConverter::convert(), IECoreHoudini::ToHoudiniGeometryConverter::convert(), IECore::CubeColorTransformOp::CubeColorTransformOp(), IECore::CurveExtrudeOp::CurveExtrudeOp(), IECore::CurveTracer::CurveTracer(), IECore::DataCastOp::DataCastOp(), IECore::DataPromoteOp::DataPromoteOp(), IECore::EnvMapSampler::EnvMapSampler(), IECore::EnvMapSHProjector::EnvMapSHProjector(), IECore::FromCoreConverter::FromCoreConverter(), IECoreMaya::FromMayaCameraConverter::FromMayaCameraConverter(), IECoreMaya::FromMayaGroupConverter::FromMayaGroupConverter(), IECoreMaya::FromMayaImageConverter::FromMayaImageConverter(), IECoreMaya::FromMayaObjectConverter::FromMayaObjectConverter(), IECoreMaya::FromMayaSkinClusterConverter::FromMayaSkinClusterConverter(), IECoreMaya::FromMayaTransformConverter::FromMayaTransformConverter(), IECoreMaya::FromMayaUnitPlugConverter< T >::FromMayaUnitPlugConverter(), IECore::Grade::Grade(), IECore::HdrMergeOp::HdrMergeOp(), IECore::IFFHairReader::IFFHairReader(), IECore::ImageDiffOp::ImageDiffOp(), IECore::CurveTracer::imageParameter(), IECore::ImageReader::ImageReader(), IECore::LimitSmoothSkinningInfluencesOp::LimitSmoothSkinningInfluencesOp(), IECore::LuminanceOp::LuminanceOp(), IECore::MappedRandomPointDistributionOp::MappedRandomPointDistributionOp(), IECore::MatrixMultiplyOp::MatrixMultiplyOp(), IECore::MedianCutSampler::MedianCutSampler(), IECore::MeshPrimitiveImplicitSurfaceOp::MeshPrimitiveImplicitSurfaceOp(), IECore::MeshPrimitiveShrinkWrapOp::MeshPrimitiveShrinkWrapOp(), IECore::CurveTracer::minimumLengthParameter(), IECore::MixSmoothSkinningWeightsOp::MixSmoothSkinningWeightsOp(), IECore::SmoothSmoothSkinningWeightsOp::modify(), IECore::AddSmoothSkinningInfluencesOp::modify(), IECore::ModifyOp::ModifyOp(), IECore::NormalizeSmoothSkinningWeightsOp::NormalizeSmoothSkinningWeightsOp(), IECore::NParticleReader::NParticleReader(), IECore::Op::operate(), IECore::CurveTracer::outputSpaceParameter(), IECore::CurveTracer::outputTypeParameter(), IECore::ParticleWriter::particleAttributes(), IECore::ParticleMeshOp::ParticleMeshOp(), IECore::ParticleReader::ParticleReader(), IECore::PointBoundsOp::PointBoundsOp(), IECore::PointDensitiesOp::PointDensitiesOp(), IECore::PointMeshOp::PointMeshOp(), IECore::PointNormalsOp::PointNormalsOp(), IECore::PointRepulsionOp::PointRepulsionOp(), IECore::PointSmoothSkinningOp::PointSmoothSkinningOp(), IECore::PointsMotionOp::PointsMotionOp(), IECore::PointVelocityDisplaceOp::PointVelocityDisplaceOp(), IECore::RandomRotationOp::RandomRotationOp(), IECore::Reader::Reader(), IECore::RemoveSmoothSkinningInfluencesOp::RemoveSmoothSkinningInfluencesOp(), IECore::ReorderSmoothSkinningInfluencesOp::ReorderSmoothSkinningInfluencesOp(), IECore::SmoothSmoothSkinningWeightsOp::SmoothSmoothSkinningWeightsOp(), IECore::SplineToImage::SplineToImage(), IECoreHoudini::ToHoudiniStringVectorAttribConverter::ToHoudiniStringVectorAttribConverter(), IECoreMaya::ToMayaSkinClusterConverter::ToMayaSkinClusterConverter(), IECore::TransformOp::TransformOp(), IECore::TriangulateOp::TriangulateOp(), IECoreTruelight::TruelightColorTransformOp::TruelightColorTransformOp(), IECore::VectorDataFilterOp::VectorDataFilterOp(), and IECore::CurveTracer::vertexMergeDistanceParameter().

ConstCompoundObjectPtr Parameterised::userData (  )  const

Read only version of the above.

CompoundObjectPtr Parameterised::userData (  ) 

Returns an object that anyone can use for storing anything.

The documentation for this class was generated from the following files:
Generated on Mon Jan 24 11:13:26 2011 for Cortex by doxygen 1.5.8