osg::FieldType Class Reference
[Fields]

#include <OSGFieldType.h>

Inheritance diagram for osg::FieldType:

osg::DataType osg::TypeBase

List of all members.

Public Types

enum  Cardinality { SINGLE_FIELD, MULTI_FIELD }
typedef Field *(* CreateFieldMethod )(void)

Public Member Functions

Constructors


 FieldType (const Char8 *szName, const Char8 *szParentName, const DataType &contentType, CreateFieldMethod createMethod, Cardinality cardinality)
 FieldType (const Char8 *szName, const Char8 *szParentName, const DataType &contentType, CreateFieldMethod createMethod, Cardinality cardinality, const FieldType &pScanAsType)
Destructor


virtual ~FieldType (void)
Get


const DataType & getContentType (void) const
Cardinality getCardinality (void) const
UInt32 getScanTypeId (void) const
Operators


bool operator== (const DataType &other) const
bool operator!= (const DataType &other) const
Comparison


bool operator== (const TypeBase &other) const
bool operator!= (const TypeBase &other) const
Id


UInt32 getId (void) const
const IDString & getName (void) const
const Char8 * getCName (void) const
const IDString & getParentName (void) const
const Char8 * getCParentName (void) const
UInt32 getNameSpace (void) const
Operators


virtual bool isDerivedFrom (const TypeBase &other) const

Protected Types

typedef DataType Inherited

Protected Attributes

Cardinality _cardinality
UInt32 _uiLoadTypeId
const DataType & _contentType
const FieldType * _pScanAsType
const CreateFieldMethod _createMethod
Members


UInt32 _uiTypeId
UInt32 _uiTypeRootId
TypeBase * _pParent
IDString _szName
IDString _szParentName

Private Member Functions

 FieldType (const FieldType &source)
 prohibit default function (move to 'public' if needed)
FieldType & operator= (const FieldType &obj)
 prohibit default function (move to 'public' if needed)

Friends

class FieldFactory

Detailed Description

Definition at line 64 of file OSGFieldType.h.

Member Typedef Documentation

typedef Field*(* osg::FieldType::CreateFieldMethod)(void)

typedef DataType osg::FieldType::Inherited [protected]

Reimplemented from osg::DataType.

Definition at line 123 of file OSGFieldType.h.

Member Enumeration Documentation

enum osg::FieldType::Cardinality

Enumerator:
SINGLE_FIELD 
MULTI_FIELD 

Definition at line 70 of file OSGFieldType.h.

00071     { 
00072         SINGLE_FIELD, 
00073         MULTI_FIELD 
00074     };

Constructor & Destructor Documentation

FieldType::FieldType ( const Char8 *  szName,
const Char8 *  szParentName,
const DataType &  contentType,
CreateFieldMethod  createMethod,
Cardinality  cardinality 
)

Definition at line 58 of file OSGFieldType.cpp.

References osg::FieldFactory::addType(), FDEBUG, and osg::TypeBase::getCName().

00062                                                            :
00063      Inherited   (szName, szParentName),
00064     _cardinality (cardinality         ),
00065     _contentType (contentType         ),
00066     _pScanAsType (NULL                ),
00067     _createMethod(createMethod        )
00068 {
00069     FieldFactory::addType(this);
00070     FDEBUG (("Initialized FieldType : %s %p\n", getCName(), this));
00071 }

FieldType::FieldType ( const Char8 *  szName,
const Char8 *  szParentName,
const DataType &  contentType,
CreateFieldMethod  createMethod,
Cardinality  cardinality,
const FieldType &  pScanAsType 
)

Definition at line 73 of file OSGFieldType.cpp.

References osg::FieldFactory::addType(), FDEBUG, and osg::TypeBase::getCName().

00078                                                              :
00079      Inherited   ( szName, szParentName),
00080     _cardinality ( cardinality         ),
00081     _contentType ( contentType         ),
00082     _pScanAsType (&pScanAsType         ),
00083     _createMethod( createMethod        )
00084 {
00085     FieldFactory::addType(this);
00086     FDEBUG (("Initialized FieldType : %s %p\n", getCName(), this));
00087 }

FieldType::~FieldType ( void   )  [virtual]

Definition at line 93 of file OSGFieldType.cpp.

00094 {
00095 }

osg::FieldType::FieldType ( const FieldType &  source  )  [private]

Member Function Documentation

const DataType & FieldType::getContentType ( void   )  const

Definition at line 100 of file OSGFieldType.cpp.

References _contentType.

Referenced by osg::Field::getContentType(), and osg::OSGLoader::mapExtIntFieldType().

00101 {
00102     return _contentType;
00103 }

FieldType::Cardinality FieldType::getCardinality ( void   )  const

Definition at line 105 of file OSGFieldType.cpp.

References _cardinality.

Referenced by osg::Field::getCardinality(), osg::OSGLoader::mapExtIntFieldType(), and osg::FieldContainerFactory::writeSingleTypeFCD().

00106 {
00107     return _cardinality;
00108 }

UInt32 FieldType::getScanTypeId ( void   )  const

Definition at line 110 of file OSGFieldType.cpp.

References _pScanAsType, and osg::TypeBase::getId().

Referenced by osg::OSGLoader::getFieldType().

00111 {
00112     if(_pScanAsType == NULL)
00113     {
00114         return getId();
00115     }
00116     else
00117     {
00118         return _pScanAsType->getId();
00119     }
00120 }

FieldType& osg::FieldType::operator= ( const FieldType &  obj  )  [private]

bool DataType::operator== ( const DataType &  other  )  const [inherited]

Definition at line 84 of file OSGDataType.cpp.

00085 {
00086     return *(static_cast<const Inherited *>(this)) == other;
00087 }

bool TypeBase::operator== ( const TypeBase &  other  )  const [inherited]

Definition at line 127 of file OSGTypeBase.cpp.

References osg::TypeBase::_uiTypeId.

00128 {
00129     return _uiTypeId == other._uiTypeId;
00130 }

bool DataType::operator!= ( const DataType &  other  )  const [inherited]

Definition at line 89 of file OSGDataType.cpp.

00090 {
00091     return ! (*this == other);
00092 }

bool TypeBase::operator!= ( const TypeBase &  other  )  const [inherited]

Definition at line 133 of file OSGTypeBase.cpp.

00134 {
00135     return ! (*this == other);
00136 }

UInt32 TypeBase::getId ( void   )  const [inherited]

Definition at line 80 of file OSGTypeBase.cpp.

References osg::TypeBase::_uiTypeId.

Referenced by osg::FieldFactory::addType(), osg::Action::callEnter(), osg::Action::callLeave(), osg::FieldContainerType::dump(), osg::XWindowBase::getClassTypeId(), osg::WindowBase::getClassTypeId(), osg::WIN32WindowBase::getClassTypeId(), osg::ViewportBase::getClassTypeId(), osg::VertexProgramChunkBase::getClassTypeId(), osg::TwoSidedLightingChunkBase::getClassTypeId(), osg::TransformChunkBase::getClassTypeId(), osg::TransformBase::getClassTypeId(), osg::TileCameraDecoratorBase::getClassTypeId(), osg::TextureTransformChunkBase::getClassTypeId(), osg::TextureGrabForegroundBase::getClassTypeId(), osg::TextureGrabBackgroundBase::getClassTypeId(), osg::TextureChunkBase::getClassTypeId(), osg::TextureBackgroundBase::getClassTypeId(), osg::TexGenChunkBase::getClassTypeId(), osg::SwitchMaterialBase::getClassTypeId(), osg::SwitchBase::getClassTypeId(), osg::SurfaceBase::getClassTypeId(), osg::StringAttributeMapBase::getClassTypeId(), osg::StereoCameraDecoratorBase::getClassTypeId(), osg::StereoBufferViewportBase::getClassTypeId(), osg::StencilChunkBase::getClassTypeId(), osg::StatisticsForegroundBase::getClassTypeId(), osg::StateSortingGroupBase::getClassTypeId(), osg::StateChunkBase::getClassTypeId(), osg::StateBase::getClassTypeId(), osg::SpotLightBase::getClassTypeId(), osg::SortFirstWindowBase::getClassTypeId(), osg::SolidBackgroundBase::getClassTypeId(), osg::SlicesBase::getClassTypeId(), osg::SkyBackgroundBase::getClassTypeId(), osg::SimpleTexturedMaterialBase::getClassTypeId(), osg::SimpleStatisticsForegroundBase::getClassTypeId(), osg::SimpleMaterialBase::getClassTypeId(), osg::SHLParameterChunkBase::getClassTypeId(), osg::SHLChunkBase::getClassTypeId(), osg::ShearedStereoCameraDecoratorBase::getClassTypeId(), osg::ShaderParameterVec4fBase::getClassTypeId(), osg::ShaderParameterVec3fBase::getClassTypeId(), osg::ShaderParameterVec2fBase::getClassTypeId(), osg::ShaderParameterStringBase::getClassTypeId(), osg::ShaderParameterRealBase::getClassTypeId(), osg::ShaderParameterMVec4fBase::getClassTypeId(), osg::ShaderParameterMVec3fBase::getClassTypeId(), osg::ShaderParameterMVec2fBase::getClassTypeId(), osg::ShaderParameterMRealBase::getClassTypeId(), osg::ShaderParameterMMatrixBase::getClassTypeId(), osg::ShaderParameterMIntBase::getClassTypeId(), osg::ShaderParameterMatrixBase::getClassTypeId(), osg::ShaderParameterIntBase::getClassTypeId(), osg::ShaderParameterChunkBase::getClassTypeId(), osg::ShaderParameterBoolBase::getClassTypeId(), osg::ShaderParameterBase::getClassTypeId(), osg::ShaderChunkBase::getClassTypeId(), osg::ScreenGroupBase::getClassTypeId(), osg::SClipPlaneChunkBase::getClassTypeId(), osg::ResolutionDisplayFilterBase::getClassTypeId(), osg::RenderOptionsBase::getClassTypeId(), osg::RegisterCombinersChunkBase::getClassTypeId(), osg::QTWindowBase::getClassTypeId(), osg::ProxyGroupBase::getClassTypeId(), osg::ProjectionCameraDecoratorBase::getClassTypeId(), osg::ProgramChunkBase::getClassTypeId(), osg::PolygonForegroundBase::getClassTypeId(), osg::PolygonChunkBase::getClassTypeId(), osg::PolygonBackgroundBase::getClassTypeId(), osg::PointLightBase::getClassTypeId(), osg::PointChunkBase::getClassTypeId(), osg::PhongMaterialBase::getClassTypeId(), osg::PerspectiveCameraBase::getClassTypeId(), osg::PassiveWindowBase::getClassTypeId(), osg::PassiveViewportBase::getClassTypeId(), osg::PassiveBackgroundBase::getClassTypeId(), osg::ParticlesBase::getClassTypeId(), osg::OrthographicCameraBase::getClassTypeId(), osg::OffCenterPerspectiveCameraBase::getClassTypeId(), osg::MultiPassMaterialBase::getClassTypeId(), osg::MultiDisplayWindowBase::getClassTypeId(), osg::MatrixCameraDecoratorBase::getClassTypeId(), osg::MatrixCameraBase::getClassTypeId(), osg::MaterialPoolBase::getClassTypeId(), osg::MaterialGroupBase::getClassTypeId(), osg::MaterialDrawableBase::getClassTypeId(), osg::MaterialChunkBase::getClassTypeId(), osg::MaterialBase::getClassTypeId(), osg::LogicOpChunkBase::getClassTypeId(), osg::LineChunkBase::getClassTypeId(), osg::LightModelChunkBase::getClassTypeId(), osg::LightEnvBase::getClassTypeId(), osg::LightChunkBase::getClassTypeId(), osg::LightBase::getClassTypeId(), osg::InverseTransformBase::getClassTypeId(), osg::InlineBase::getClassTypeId(), osg::ImageForegroundBase::getClassTypeId(), osg::ImageComposerBase::getClassTypeId(), osg::ImageBase::getClassTypeId(), osg::ImageBackgroundBase::getClassTypeId(), osg::GroupBase::getClassTypeId(), osg::GraphicStatisticsForegroundBase::getClassTypeId(), osg::GradientBackgroundBase::getClassTypeId(), osg::GrabForegroundBase::getClassTypeId(), osg::GLUTWindowBase::getClassTypeId(), osg::GeometryBase::getClassTypeId(), osg::FresnelMaterialBase::getClassTypeId(), osg::FragmentProgramChunkBase::getClassTypeId(), osg::ForegroundBase::getClassTypeId(), osg::FileGrabForegroundBase::getClassTypeId(), osg::FieldContainer::getClassTypeId(), osg::FCPtrAttributeMapBase::getClassTypeId(), osg::FBOViewportBase::getClassTypeId(), osg::FatBorderChunkBase::getClassTypeId(), osg::DVRVolumeTextureBase::getClassTypeId(), osg::DVRVolumeBase::getClassTypeId(), osg::DVRSimpleShaderBase::getClassTypeId(), osg::DVRSimpleLUTShaderBase::getClassTypeId(), osg::DVRShaderBase::getClassTypeId(), osg::DVRMtexLUTShaderBase::getClassTypeId(), osg::DVRLookupTableBase::getClassTypeId(), osg::DVRIsoSurfaceBase::getClassTypeId(), osg::DVRIsoShaderBase::getClassTypeId(), osg::DVRGeometryBase::getClassTypeId(), osg::DVRClipObjectsBase::getClassTypeId(), osg::DVRClipGeometryBase::getClassTypeId(), osg::DVRAppearanceBase::getClassTypeId(), osg::DrawableBase::getClassTypeId(), osg::DistortionDisplayFilterBase::getClassTypeId(), osg::DistanceLODBase::getClassTypeId(), osg::DisplayFilterForegroundBase::getClassTypeId(), osg::DisplayFilterBase::getClassTypeId(), osg::DisplayCalibrationBase::getClassTypeId(), osg::DirectionalLightBase::getClassTypeId(), osg::DepthClearBackgroundBase::getClassTypeId(), osg::DepthChunkBase::getClassTypeId(), osg::CubeTextureChunkBase::getClassTypeId(), osg::ComponentTransformBase::getClassTypeId(), osg::ColorMaskChunkBase::getClassTypeId(), osg::ColorDisplayFilterBase::getClassTypeId(), osg::ColorBufferViewportBase::getClassTypeId(), osg::ClusterWindowBase::getClassTypeId(), osg::ClipPlaneChunkBase::getClassTypeId(), osg::ClipPlaneBase::getClassTypeId(), osg::ChunkMaterialBase::getClassTypeId(), osg::CameraDecoratorBase::getClassTypeId(), osg::CameraBase::getClassTypeId(), osg::BlendChunkBase::getClassTypeId(), osg::BillboardBase::getClassTypeId(), osg::BackgroundBase::getClassTypeId(), osg::VRMLFile::getFieldType(), osg::SingleFunctorStore::getFunctor(), osg::MultiFunctorStore::getFunctor(), getScanTypeId(), osg::MPBase::getTypeId(), osg::FieldDescription::getTypeId(), osg::FieldContainer::getTypeId(), osg::FieldContainerFactory::initializePendingTypes(), osg::VRMLNodeDesc::prototypeAddField(), osg::SingleFunctorStore::regFunctor(), osg::MultiFunctorStore::regFunctor(), osg::RemoteAspect::registerChanged(), osg::RemoteAspect::registerCreated(), osg::RemoteAspect::registerDestroyed(), osg::RenderAction::registerEnterDefault(), osg::IntersectAction::registerEnterDefault(), osg::DrawAction::registerEnterDefault(), osg::Action::registerEnterDefault(), osg::Action::registerEnterFunction(), osg::RenderAction::registerLeaveDefault(), osg::IntersectAction::registerLeaveDefault(), osg::DrawAction::registerLeaveDefault(), osg::Action::registerLeaveDefault(), osg::Action::registerLeaveFunction(), osg::FieldContainerFactory::registerType(), osg::RemoteAspect::RemoteAspect(), osg::MultiFunctorStore::unregFunctor(), and osg::FieldContainerFactory::unregisterType().

00081 {
00082     return _uiTypeId; 
00083 }

const IDString & TypeBase::getName ( void   )  const [inherited]

Definition at line 86 of file OSGTypeBase.cpp.

References osg::TypeBase::_szName.

Referenced by osg::SharePtrGraphOp::compareFCs(), osg::deepClone(), osg::NodeCore::dump(), osg::Geometry::dump(), osg::Attachment::dump(), osg::VRMLFile::getFieldType(), osg::VRMLNodeDesc::prototypeAddField(), and osg::TypeFactory::registerType().

00087 {
00088     return _szName;
00089 }

const Char8 * TypeBase::getCName ( void   )  const [inherited]

Definition at line 92 of file OSGTypeBase.cpp.

References osg::TypeBase::_szName, and osg::IDString::str().

Referenced by osg::SharePtrGraphOp::addAttachmentParent(), osg::StandardStringConversionState::beginField(), osg::SharePtrGraphOp::clearAttachmentParent(), osg::SharePtrGraphOp::compareFCs(), osg::QFieldLabelFactory::createLabel(), osg::deepClone(), osg::BINWriter::doIndexFC(), osg::VRMLNodeDesc::dump(), osg::FieldContainerType::dump(), FieldType(), osg::FieldFactory::getFieldTypeName(), osg::getParentsField(), osg::FieldContainer::getTypeName(), osg::FieldContainerType::initFields(), osg::FieldContainerType::initialize(), osg::FieldContainerFactory::initializePendingTypes(), osg::SharePtrGraphOp::isEqual(), isEqual(), osg::isMFFieldContainerPtr(), osg::isSFFieldContainerPtr(), osg::OSGLoader::mapExtIntFieldType(), osg::RemoteAspect::receiveSync(), osg::TypeFactory::registerType(), osg::FieldContainerFactory::unregisterType(), osg::MultiDisplayWindow::updateViewport(), osg::OSGWriter::visitField(), osg::FieldContainerFactory::writeFCD(), osg::OSGWriter::writeField(), osg::FieldContainerFactory::writeSingleTypeFCD(), and osg::TypeFactory::writeTypeDot().

00093 {
00094     return _szName.str(); 
00095 }

const IDString & TypeBase::getParentName ( void   )  const [inherited]

Definition at line 98 of file OSGTypeBase.cpp.

References osg::TypeBase::_szParentName.

00099 {
00100     return _szParentName;
00101 }

const Char8 * TypeBase::getCParentName ( void   )  const [inherited]

Definition at line 104 of file OSGTypeBase.cpp.

References osg::TypeBase::_szParentName, and osg::IDString::str().

Referenced by osg::TypeFactory::writeTypeDot().

00105 {
00106     return _szParentName.str();
00107 }

UInt32 TypeBase::getNameSpace ( void   )  const [inherited]

Definition at line 110 of file OSGTypeBase.cpp.

Referenced by osg::TypeFactory::registerType().

00111 {
00112     return 0;
00113 }

bool TypeBase::isDerivedFrom ( const TypeBase &  other  )  const [virtual, inherited]

Reimplemented in osg::FieldContainerType.

Definition at line 119 of file OSGTypeBase.cpp.

Referenced by osg::FieldContainerType::isDerivedFrom().

00120 {
00121     return false;
00122 }

Friends And Related Function Documentation

friend class FieldFactory [friend]

Definition at line 139 of file OSGFieldType.h.

Member Data Documentation

Cardinality osg::FieldType::_cardinality [protected]

Definition at line 128 of file OSGFieldType.h.

Referenced by getCardinality().

UInt32 osg::FieldType::_uiLoadTypeId [protected]

Definition at line 129 of file OSGFieldType.h.

osg::FieldType::_contentType [protected]

Type stored within fields of this type

Definition at line 131 of file OSGFieldType.h.

Referenced by getContentType().

const FieldType* osg::FieldType::_pScanAsType [protected]

Definition at line 132 of file OSGFieldType.h.

Referenced by getScanTypeId().

const CreateFieldMethod osg::FieldType::_createMethod [protected]

Definition at line 134 of file OSGFieldType.h.

Referenced by osg::FieldFactory::createField().

UInt32 osg::TypeBase::_uiTypeId [protected, inherited]

Definition at line 114 of file OSGTypeBase.h.

Referenced by osg::TypeBase::getId(), osg::FieldContainerType::isDerivedFrom(), osg::TypeBase::operator==(), and osg::TypeBase::TypeBase().

UInt32 osg::TypeBase::_uiTypeRootId [protected, inherited]

Definition at line 115 of file OSGTypeBase.h.

TypeBase* osg::TypeBase::_pParent [protected, inherited]

Reimplemented in osg::FieldContainerType.

Definition at line 117 of file OSGTypeBase.h.

IDString osg::TypeBase::_szName [protected, inherited]

Definition at line 119 of file OSGTypeBase.h.

Referenced by osg::FieldContainerType::addDescription(), osg::TypeBase::getCName(), osg::TypeBase::getName(), osg::FieldContainerType::initFields(), osg::FieldContainerType::initialize(), and osg::FieldContainerType::registerType().

IDString osg::TypeBase::_szParentName [protected, inherited]

Reimplemented in osg::FieldContainerType.

Definition at line 120 of file OSGTypeBase.h.

Referenced by osg::TypeBase::getCParentName(), and osg::TypeBase::getParentName().

The documentation for this class was generated from the following files:
Generated on Mon Mar 17 11:10:54 2008 for OpenSG by  doxygen 1.5.5