OSG::Background Class Reference

Background clearing base class. See PageSystemWindowBackground for a description. More...

#include <OSGBackground.h>

Inheritance diagram for OSG::Background:


dcast

	OSG_GEN_INTERNALPTR (AttachmentContainer)
typedef AttachmentContainer	Self
typedef FieldContainerAttachment	AttachmentObj
typedef FieldContainerAttachmentPtr	AttachmentObjPtr
typedef SFFieldContainerAttachmentPtrMap	SFAttachmentObjPtrMap
typedef SFAttachmentObjPtrMap::StoredType	AttachmentObjPtrMap
typedef AttachmentObjPtrMap::iterator	AttachmentObjPtrMapIt
Type definitions

	OSG_GEN_INTERNALPTR (FieldContainer)
	OSG_RC_FIRST_FIELD_DECL (ChangedCallbacks)
	OSG_RC_LAST_FIELD_DECL (ChangedCallbacks)
static const bool	isNodeCore = false
Public Types
enum	{ ClearStencilBitFieldId = Inherited::NextFieldId, DepthFieldId = ClearStencilBitFieldId + 1, NextFieldId = DepthFieldId + 1 }
typedef AttachmentContainer	ParentContainer
typedef Inherited::TypeObject	TypeObject
typedef TypeObject::InitPhase	InitPhase
Type definitions

typedef Field (ReflexiveContainer::)	FieldEditMethod (void)
typedef const Field (ReflexiveContainer::)	FieldGetMethod (void) const
Public Member Functions
	OSG_GEN_INTERNALPTR (Background)
access fields

virtual void	clear (DrawEnv pEnv, Viewport pPort)=0
transformation

virtual void	changed (ConstFieldMaskArg whichField, UInt32 origin, BitVector detail)
dump

virtual void	dump (UInt32 uiIndent=0, const BitVector bvFlags=0) const
FieldContainer Get

virtual FieldContainerType &	getType (void)
virtual const FieldContainerType &	getType (void) const
virtual UInt32	getContainerSize (void) const
Field Get

SFInt32 *	editSFClearStencilBit (void)
const SFInt32 *	getSFClearStencilBit (void) const
SFReal32 *	editSFDepth (void)
const SFReal32 *	getSFDepth (void) const
Int32 &	editClearStencilBit (void)
	Get the value of the Background::_sfClearStencilBit field.
const Int32 &	getClearStencilBit (void) const
	Get the value of the Background::_sfClearStencilBit field.
Real32 &	editDepth (void)
	Get the value of the Background::_sfDepth field.
const Real32 &	getDepth (void) const
	Get the value of the Background::_sfDepth field.
Field Set

void	setClearStencilBit (const Int32 &value)
	Set the value of the Background::_sfClearStencilBit field.
void	setDepth (const Real32 &value)
	Set the value of the Background::_sfDepth field.
Binary Access

virtual UInt32	getBinSize (ConstFieldMaskArg whichField)
virtual void	copyToBin (BinaryDataHandler &pMem, ConstFieldMaskArg whichField)
virtual void	copyFromBin (BinaryDataHandler &pMem, ConstFieldMaskArg whichField)
Constructors

	OSG_RC_FIRST_FIELD_DECL (Attachments)
	OSG_RC_LAST_FIELD_DECL (Attachments)
Set

void	addAttachment (const AttachmentObjPtr attachmentP, UInt16 binding=0)
void	subAttachment (const AttachmentObjPtr attachmentP, UInt16 binding=0)
AttachmentObjPtr	findAttachment (UInt32 groupId, UInt16 binding=0)
AttachmentObjPtr	findAttachment (const FieldContainerType &type, UInt16 binding=0)
your_category

const SFAttachmentObjPtrMap *	getSFAttachments (void) const
Get

virtual ObjPtr	shallowCopy (void) const=0
Set

void	callChangedFunctors (ConstFieldMaskArg whichField)
Container Access

UInt32	addChangedFunctor (ChangedFunctor func, std::string createSymbol)
template<class FunctorT>
void	subChangedFunctor (FunctorT func)
void	subChangedFunctor (UInt32 uiId)
void	clearChangedFunctors (void)
Field Flags

const FieldFlags *	getFieldFlags (void)
Helper

OSG_SYSTEM_DLLMAPPING void	addReference (void)
OSG_SYSTEM_DLLMAPPING void	subReference (void)
OSG_SYSTEM_DLLMAPPING void	subReferenceLocalVar (void)
OSG_SYSTEM_DLLMAPPING Int32	getRefCount (void) const
Comparison

virtual OSG_SYSTEM_DLLMAPPING void	invalidateVolume (void)
dcast

OSG_SYSTEM_DLLMAPPING UInt32	getTypeId (void) const
OSG_SYSTEM_DLLMAPPING UInt16	getGroupId (void) const
OSG_SYSTEM_DLLMAPPING const Char8 *	getTypeName (void) const
Get Field

OSG_SYSTEM_DLLMAPPING UInt32	getNumFields (void) const
OSG_SYSTEM_DLLMAPPING EditFieldHandlePtr	editField (UInt32 fieldId)
OSG_SYSTEM_DLLMAPPING EditFieldHandlePtr	editField (const Char8 *fieldName)
OSG_SYSTEM_DLLMAPPING GetFieldHandlePtr	getField (UInt32 fieldId) const
OSG_SYSTEM_DLLMAPPING GetFieldHandlePtr	getField (const Char8 *fieldName) const
Get Field Description

OSG_SYSTEM_DLLMAPPING FieldDescriptionBase *	getFieldDescription (UInt32 fieldId)
OSG_SYSTEM_DLLMAPPING FieldDescriptionBase *	getFieldDescription (const Char8 *fieldName)
Comparison

OSG_SYSTEM_DLLMAPPING EditFieldHandlePtr	invalidEditField (void)
OSG_SYSTEM_DLLMAPPING GetFieldHandlePtr	invalidGetField (void) const
Static Public Member Functions
Class Get

static FieldContainerType &	getClassType (void)
	access the type of the class
static UInt32	getClassTypeId (void)
	access the numerical type of the class
static UInt16	getClassGroupId (void)
	access the type of the class
Public Attributes
General Fieldcontainer Declaration

	OSG_ABSTR_FIELD_CONTAINER_DECL
Static Public Attributes
static const OSG::BitVector	ClearStencilBitFieldMask
static const OSG::BitVector	DepthFieldMask
static const OSG::BitVector	NextFieldMask
Protected Member Functions
Constructors

	Background (void)
	Background (const Background &source)
Destructors

virtual	~Background (void)
Generic Field Access

GetFieldHandlePtr	getHandleClearStencilBit (void) const
EditFieldHandlePtr	editHandleClearStencilBit (void)
GetFieldHandlePtr	getHandleDepth (void) const
EditFieldHandlePtr	editHandleDepth (void)
Sync

virtual void	resolveLinks (void)
Sync

EditFieldHandlePtr	editHandleAttachments (void)
GetFieldHandlePtr	getHandleAttachments (void) const
Edit

OSG_SYSTEM_DLLMAPPING void	subReferenceUnresolved (void)
MT Construction

OSG_SYSTEM_DLLMAPPING void	onCreateAspect (const FieldContainer createAspect, const FieldContainer source=NULL)
OSG_SYSTEM_DLLMAPPING void	onCreate (const FieldContainer *source=NULL)
virtual OSG_SYSTEM_DLLMAPPING void	onDestroy (UInt32 uiContainerId)
Changed

OSG_SYSTEM_DLLMAPPING void	onCreate (const ReflexiveContainer *source=NULL)
virtual OSG_SYSTEM_DLLMAPPING void	onDestroyAspect (UInt32 uiContainerId, UInt32 uiAspect)
MT Construction

virtual OSG_SYSTEM_DLLMAPPING bool	deregister (UInt32 uiContainerId)
MT Construction

OSG_SYSTEM_DLLMAPPING void	registerChangedContainer (void)
virtual OSG_SYSTEM_DLLMAPPING void	registerChangedContainerV (void)
Local Edit

void	editSField (ConstFieldMaskArg whichField)
template<class FieldT>
void	editMField (ConstFieldMaskArg whichField, FieldT &oField)
MT Destruction

void	execEndEdit (ConstFieldMaskArg whichField)
void	clearChangeEntry (ContainerChangeEntry *pRef)
Edit

OSG_SYSTEM_DLLMAPPING void	setId (UInt32 uiContainerId)
OSG_SYSTEM_DLLMAPPING UInt32	getId (void) const
Static Protected Member Functions
static void	classDescInserter (TypeObject &oType)
static Char8 *	getClassname (void)
Init

static void	initMethod (InitPhase ePhase)
Fields

static void	classDescInserter (TypeObject &oType)
MT Construction

template<class ObjectT>
static void	newPtr (typename ObjectT::ObjPtr &result, const ObjectT *prototypeP)
template<class ObjectT>
static void	newPtr (typename ObjectT::ObjPtr &result)
Protected Attributes
Fields

SFInt32	_sfClearStencilBit
SFReal32	_sfDepth
Fields

SFAttachmentObjPtrMap	_sfAttachments
Type information

FieldFlags *	_pFieldFlags
MFChangedFunctorCallback	_mfChangedFunctors
Int32	_iRefCount
Member

BitVector	_bvChanged
ContainerChangeEntry *	_pContainerChanges
UInt32	_uiContainerId
Static Protected Attributes
static TypeObject	_type
Private Types
typedef BackgroundBase	Inherited
Private Member Functions
void	operator= (const Background &source)
Friends
class	FieldContainer
class	BackgroundBase

Detailed Description

Background is the base class for all background/buffer clearing. See PageSystemWindowBackground for a description.

Ext:

To create a new Background the method that has be overridden is clear(DrawActionBase * action, Viewport * port);. It can directly call OpenGL commands, but should restore the state after it's done.

Definition at line 56 of file OSGBackground.h.

Member Typedef Documentation

typedef BackgroundBase OSG::Background::Inherited [private]

Reimplemented from OSG::BackgroundBase.

Reimplemented in OSG::TextureBackgroundBase, OSG::PassiveBackgroundBase, OSG::DepthClearBackgroundBase, OSG::PolygonBackground, OSG::TextureGrabBackground, OSG::SkyBackground, OSG::PolygonBackgroundBase, OSG::TextureGrabBackgroundBase, OSG::GradientBackground, OSG::SkyBackgroundBase, OSG::SolidBackground, OSG::GradientBackgroundBase, OSG::TextureBackground, OSG::SolidBackgroundBase, OSG::PassiveBackground, and OSG::DepthClearBackground.

Definition at line 117 of file OSGBackground.h.

typedef AttachmentContainer OSG::BackgroundBase::ParentContainer [inherited]

Reimplemented in OSG::TextureBackgroundBase, OSG::PassiveBackgroundBase, OSG::DepthClearBackgroundBase, OSG::PolygonBackgroundBase, OSG::TextureGrabBackgroundBase, OSG::SkyBackgroundBase, OSG::GradientBackgroundBase, and OSG::SolidBackgroundBase.

Definition at line 84 of file OSGBackgroundBase.h.

typedef Inherited::TypeObject OSG::BackgroundBase::TypeObject [inherited]

Reimplemented from OSG::AttachmentContainer.

Definition at line 86 of file OSGBackgroundBase.h.

typedef TypeObject::InitPhase OSG::BackgroundBase::InitPhase [inherited]

Reimplemented from OSG::ReflexiveContainer.

Definition at line 87 of file OSGBackgroundBase.h.

typedef AttachmentContainer OSG::AttachmentContainer::Self [inherited]

Reimplemented from OSG::FieldContainer.

Reimplemented in OSG::ScreenLOD, OSG::MultiCore, OSG::ChunkOverrideGroup, OSG::Node, OSG::StageHandlerMixin< ContainerMixinHead< ShadowMapEngineDesc > >, and OSG::StageHandlerMixin< ContainerMixinHead< StageDesc > >.

Definition at line 68 of file OSGAttachmentContainer.h.

typedef FieldContainerAttachment OSG::AttachmentContainer::AttachmentObj [inherited]

Definition at line 70 of file OSGAttachmentContainer.h.

typedef FieldContainerAttachmentPtr OSG::AttachmentContainer::AttachmentObjPtr [inherited]

Definition at line 71 of file OSGAttachmentContainer.h.

typedef SFFieldContainerAttachmentPtrMap OSG::AttachmentContainer::SFAttachmentObjPtrMap [inherited]

Definition at line 72 of file OSGAttachmentContainer.h.

typedef SFAttachmentObjPtrMap::StoredType OSG::AttachmentContainer::AttachmentObjPtrMap [inherited]

Definition at line 74 of file OSGAttachmentContainer.h.

typedef AttachmentObjPtrMap::iterator OSG::AttachmentContainer::AttachmentObjPtrMapIt [inherited]

Definition at line 75 of file OSGAttachmentContainer.h.

typedef Field*(ReflexiveContainer::*) OSG::ReflexiveContainer::FieldEditMethod(void) [inherited]

Definition at line 79 of file OSGReflexiveContainer.h.

typedef const Field*(ReflexiveContainer::*) OSG::ReflexiveContainer::FieldGetMethod(void) const [inherited]

Definition at line 81 of file OSGReflexiveContainer.h.

Member Enumeration Documentation

anonymous enum [inherited]

Enumerator:

ClearStencilBitFieldId
DepthFieldId
NextFieldId

Definition at line 95 of file OSGBackgroundBase.h.

00096     {
00097         ClearStencilBitFieldId = Inherited::NextFieldId,
00098         DepthFieldId = ClearStencilBitFieldId + 1,
00099         NextFieldId = DepthFieldId + 1
00100     };

Constructor & Destructor Documentation

Background::Background ( void ) [protected]

Definition at line 80 of file OSGBackground.cpp.

00080                            :
00081     Inherited()
00082 {
00083 }

Background::Background ( const Background & source ) [protected]

Definition at line 85 of file OSGBackground.cpp.

00085                                                :
00086     Inherited(source)
00087 {
00088 }

Background::~Background ( void ) [protected, virtual]

Definition at line 90 of file OSGBackground.cpp.

00091 {
00092 }

Member Function Documentation

virtual void OSG::Background::clear	(	DrawEnv *	pEnv,
		Viewport *	pPort
	)			`[pure virtual]`

Implemented in OSG::PolygonBackground, OSG::TextureGrabBackground, OSG::SkyBackground, OSG::GradientBackground, OSG::SolidBackground, OSG::TextureBackground, OSG::PassiveBackground, and OSG::DepthClearBackground.

Referenced by OSG::RenderAction::start().

void Background::changed	(	ConstFieldMaskArg	whichField,
		UInt32	origin,
		BitVector	detail
	)			`[virtual]`

Reimplemented from OSG::FieldContainer.

Reimplemented in OSG::PolygonBackground, OSG::TextureGrabBackground, OSG::SkyBackground, OSG::GradientBackground, OSG::SolidBackground, OSG::TextureBackground, OSG::PassiveBackground, and OSG::DepthClearBackground.

Definition at line 94 of file OSGBackground.cpp.

References OSG::FieldContainer::changed().

Referenced by OSG::TextureBackground::changed(), OSG::SolidBackground::changed(), OSG::SkyBackground::changed(), OSG::PolygonBackground::changed(), OSG::PassiveBackground::changed(), OSG::GradientBackground::changed(), and OSG::DepthClearBackground::changed().

00097 {
00098     Inherited::changed(whichField, origin, details);
00099 }

virtual void OSG::Background::dump	(	UInt32	uiIndent = `0`,
		const BitVector	bvFlags = `0`
	)			const `[virtual]`

Reimplemented from OSG::AttachmentContainer.

void Background::initMethod ( InitPhase ePhase ) [static, protected]

Reimplemented from OSG::FieldContainer.

Reimplemented in OSG::SolidBackground, OSG::TextureBackground, and OSG::PassiveBackground.

Definition at line 69 of file OSGBackground.cpp.

References OSG::FieldContainer::initMethod().

Referenced by OSG::TextureBackground::initMethod(), and OSG::SolidBackground::initMethod().

00070 {
00071     Inherited::initMethod(ePhase);
00072 }

void OSG::Background::operator= ( const Background & source ) [private]

OSG::BackgroundBase::OSG_GEN_INTERNALPTR ( Background ) [inherited]

OSG::AttachmentContainer::OSG_GEN_INTERNALPTR ( AttachmentContainer ) [inherited]

OSG::FieldContainer::OSG_GEN_INTERNALPTR ( FieldContainer ) [inherited]

OSG::FieldContainerType & OSG::BackgroundBase::getClassType ( void ) [inline, static, inherited]

Reimplemented from OSG::FieldContainer.

Definition at line 56 of file OSGBackgroundBase.inl.

References OSG::BackgroundBase::_type.

00057 {
00058     return _type;
00059 }

OSG::UInt32 OSG::BackgroundBase::getClassTypeId ( void ) [inline, static, inherited]

Reimplemented from OSG::FieldContainer.

Definition at line 63 of file OSGBackgroundBase.inl.

References OSG::BackgroundBase::_type, and OSG::TypeBase::getId().

00064 {
00065     return _type.getId();
00066 }

OSG::UInt16 OSG::BackgroundBase::getClassGroupId ( void ) [inline, static, inherited]

Reimplemented from OSG::FieldContainer.

Definition at line 69 of file OSGBackgroundBase.inl.

References OSG::BackgroundBase::_type, and OSG::ReflexiveContainerType::getGroupId().

00070 {
00071     return _type.getGroupId();
00072 }

FieldContainerType & OSG::BackgroundBase::getType ( void ) [virtual, inherited]

Reimplemented from OSG::FieldContainer.

Definition at line 208 of file OSGBackgroundBase.cpp.

References OSG::BackgroundBase::_type.

00209 {
00210     return _type;
00211 }

const FieldContainerType & OSG::BackgroundBase::getType ( void ) const [virtual, inherited]

Reimplemented from OSG::FieldContainer.

Definition at line 213 of file OSGBackgroundBase.cpp.

References OSG::BackgroundBase::_type.

00214 {
00215     return _type;
00216 }

UInt32 OSG::BackgroundBase::getContainerSize ( void ) const [virtual, inherited]

Implements OSG::ReflexiveContainer.

Definition at line 218 of file OSGBackgroundBase.cpp.

00219 {
00220     return sizeof(Background);
00221 }

SFInt32 * OSG::BackgroundBase::editSFClearStencilBit ( void ) [inherited]

Definition at line 226 of file OSGBackgroundBase.cpp.

References OSG::BackgroundBase::_sfClearStencilBit, OSG::BackgroundBase::ClearStencilBitFieldMask, and OSG::FieldContainer::editSField().

00227 {
00228     editSField(ClearStencilBitFieldMask);
00229 
00230     return &_sfClearStencilBit;
00231 }

const SFInt32 * OSG::BackgroundBase::getSFClearStencilBit ( void ) const [inherited]

Definition at line 233 of file OSGBackgroundBase.cpp.

References OSG::BackgroundBase::_sfClearStencilBit.

00234 {
00235     return &_sfClearStencilBit;
00236 }

SFReal32 * OSG::BackgroundBase::editSFDepth ( void ) [inherited]

Definition at line 245 of file OSGBackgroundBase.cpp.

References OSG::BackgroundBase::_sfDepth, OSG::BackgroundBase::DepthFieldMask, and OSG::FieldContainer::editSField().

00246 {
00247     editSField(DepthFieldMask);
00248 
00249     return &_sfDepth;
00250 }

const SFReal32 * OSG::BackgroundBase::getSFDepth ( void ) const [inherited]

Definition at line 252 of file OSGBackgroundBase.cpp.

References OSG::BackgroundBase::_sfDepth.

00253 {
00254     return &_sfDepth;
00255 }

Int32 & OSG::BackgroundBase::editClearStencilBit ( void ) [inline, inherited]

Definition at line 79 of file OSGBackgroundBase.inl.

References OSG::BackgroundBase::_sfClearStencilBit, OSG::BackgroundBase::ClearStencilBitFieldMask, and OSG::FieldContainer::editSField().

00080 {
00081     editSField(ClearStencilBitFieldMask);
00082 
00083     return _sfClearStencilBit.getValue();
00084 }

const Int32 & OSG::BackgroundBase::getClearStencilBit ( void ) const [inline, inherited]

Definition at line 88 of file OSGBackgroundBase.inl.

References OSG::BackgroundBase::_sfClearStencilBit.

Referenced by OSG::TextureBackground::clear(), OSG::SolidBackground::clear(), OSG::SkyBackground::clear(), OSG::PolygonBackground::clear(), OSG::GradientBackground::clear(), and OSG::DepthClearBackground::clear().

00089 {
00090     return _sfClearStencilBit.getValue();
00091 }

Real32 & OSG::BackgroundBase::editDepth ( void ) [inline, inherited]

Definition at line 112 of file OSGBackgroundBase.inl.

References OSG::BackgroundBase::_sfDepth, OSG::BackgroundBase::DepthFieldMask, and OSG::FieldContainer::editSField().

00113 {
00114     editSField(DepthFieldMask);
00115 
00116     return _sfDepth.getValue();
00117 }

const Real32 & OSG::BackgroundBase::getDepth ( void ) const [inline, inherited]

Definition at line 121 of file OSGBackgroundBase.inl.

References OSG::BackgroundBase::_sfDepth.

Referenced by OSG::SolidBackground::clear(), and OSG::DepthClearBackground::clear().

00122 {
00123     return _sfDepth.getValue();
00124 }

void OSG::BackgroundBase::setClearStencilBit ( const Int32 & value ) [inline, inherited]

Definition at line 103 of file OSGBackgroundBase.inl.

References OSG::BackgroundBase::_sfClearStencilBit, OSG::BackgroundBase::ClearStencilBitFieldMask, and OSG::FieldContainer::editSField().

00104 {
00105     editSField(ClearStencilBitFieldMask);
00106 
00107     _sfClearStencilBit.setValue(value);
00108 }

void OSG::BackgroundBase::setDepth ( const Real32 & value ) [inline, inherited]

Definition at line 136 of file OSGBackgroundBase.inl.

References OSG::BackgroundBase::_sfDepth, OSG::BackgroundBase::DepthFieldMask, and OSG::FieldContainer::editSField().

00137 {
00138     editSField(DepthFieldMask);
00139 
00140     _sfDepth.setValue(value);
00141 }

UInt32 OSG::BackgroundBase::getBinSize ( ConstFieldMaskArg whichField ) [virtual, inherited]

Reimplemented from OSG::AttachmentContainer.

Definition at line 270 of file OSGBackgroundBase.cpp.

References OSG::BackgroundBase::_sfClearStencilBit, OSG::BackgroundBase::_sfDepth, OSG::BackgroundBase::ClearStencilBitFieldMask, OSG::BackgroundBase::DepthFieldMask, OSG::ReflexiveContainer::getBinSize(), and OSG::FieldBits::NoField.

Referenced by OSG::TextureBackgroundBase::getBinSize(), OSG::SolidBackgroundBase::getBinSize(), OSG::SkyBackgroundBase::getBinSize(), OSG::PolygonBackgroundBase::getBinSize(), OSG::PassiveBackgroundBase::getBinSize(), OSG::GradientBackgroundBase::getBinSize(), and OSG::DepthClearBackgroundBase::getBinSize().

00271 {
00272     UInt32 returnValue = Inherited::getBinSize(whichField);
00273 
00274     if(FieldBits::NoField != (ClearStencilBitFieldMask & whichField))
00275     {
00276         returnValue += _sfClearStencilBit.getBinSize();
00277     }
00278     if(FieldBits::NoField != (DepthFieldMask & whichField))
00279     {
00280         returnValue += _sfDepth.getBinSize();
00281     }
00282 
00283     return returnValue;
00284 }

void OSG::BackgroundBase::copyToBin	(	BinaryDataHandler &	pMem,
		ConstFieldMaskArg	whichField
	)			`[virtual, inherited]`

Reimplemented from OSG::AttachmentContainer.

Definition at line 286 of file

OSG::Background Class Reference

dcast

Type definitions

Public Types

Public Member Functions

Static Public Member Functions

Public Attributes

Static Public Attributes

Protected Member Functions

Static Protected Member Functions

Protected Attributes

Static Protected Attributes

Private Types

Private Member Functions

Friends

Detailed Description

Member Typedef Documentation

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation