#include <TfObject.h>

Inheritance diagram for OdTfObject:

Public Types
typedef OdTfPropertiesContainer::size_type	PropertyIndexType

typedef OdTfVariantArray::size_type	ItemIndexType

Public Types inherited from OdGiDrawable
enum	SetAttributesFlags { kDrawableNone = 0, kDrawableIsAnEntity = 1, kDrawableUsesNesting = 2, kDrawableIsCompoundObject = 4, kDrawableViewIndependentViewportDraw = 8, kDrawableIsInvisible = 16, kDrawableHasAttributes = 32, kDrawableRegenTypeDependantGeometry = 64, kDrawableIsDimension = (kDrawableIsAnEntity + kDrawableIsCompoundObject + 128), kDrawableRegenDraw = 256, kDrawableStandardDisplaySingleLOD = 512, kDrawableShadedDisplaySingleLOD = 1024, kDrawableViewDependentViewportDraw = 2048, kDrawableBlockDependentViewportDraw = 4096, kDrawableIsExternalReference = 8192, kDrawableNotPlottable = 16384, kLastFlag = kDrawableNotPlottable }

enum	DrawableType { kGeometry = 0, kDistantLight = 1, kPointLight = 2, kSpotLight = 3, kAmbientLight, kSolidBackground, kGradientBackground, kImageBackground, kGroundPlaneBackground, kViewport, kWebLight, kSkyBackground, kImageBasedLightingBackground }

Public Member Functions
virtual const OdTfObject *	getOwner () const =0

virtual OdResult	getProperty (const OdTfProperty *pPI, OdTfVariant &value, const ItemIndexType arrayIndex=-1) const =0

virtual OdResult	setProperty (const OdTfProperty *pPI, const OdTfVariant &value, const ItemIndexType arrayIndex=-1)=0

virtual OdResult	getProperty (const OdString &name, OdTfVariant &value, const ItemIndexType arrayIndex=-1, const OdTfClass *pClass=NULL) const =0

virtual OdResult	setProperty (const OdString &name, const OdTfVariant &value, const ItemIndexType arrayIndex=-1, const OdTfClass *pClass=NULL)=0

virtual OdResult	getProperty (const PropertyIndexType propertyIndex, OdTfVariant &value, const ItemIndexType arrayIndex=-1) const =0

virtual OdResult	setProperty (const PropertyIndexType propertyIndex, const OdTfVariant &value, const ItemIndexType arrayIndex=-1)=0

virtual void	addReactor (OdTfObjectReactor *pReactor)=0

virtual void	removeReactor (OdTfObjectReactor *pReactor)=0

virtual void	addPersistentReactor (OdTfPersistentReactor *)=0

virtual void	removePersistentReactor (OdTfPersistentReactor *)=0

virtual bool	hasPersistentReactor (OdTfPersistentReactor *) const =0

virtual void	getPersistentReactors (OdTfPersistentReactorArray &elmIds)=0

virtual void	getTransientReactors (OdTfObjectReactorArray &reactors)=0

Public Member Functions inherited from OdGiDrawable
	ODRX_DECLARE_MEMBERS (OdGiDrawable)

virtual DrawableType	drawableType () const

ODRX_SEALED_VIRTUAL OdUInt32	setAttributes (OdGiDrawableTraits *pTraits) const ODRX_SEALED

ODRX_SEALED_VIRTUAL bool	worldDraw (OdGiWorldDraw *pWd) const ODRX_SEALED

ODRX_SEALED_VIRTUAL void	viewportDraw (OdGiViewportDraw *pVd) const ODRX_SEALED

virtual bool	isPersistent () const =0

virtual OdDbStub *	id () const =0

virtual void	setGsNode (OdGsCache *pGsNode)=0

virtual OdGsCache *	gsNode () const =0

ODRX_SEALED_VIRTUAL OdUInt32	viewportDrawLogicalFlags (OdGiViewportDraw *pVd) const ODRX_SEALED

virtual OdResult	getGeomExtents (OdGeExtents3d &extents) const

ODRX_SEALED_VIRTUAL OdUInt32	regenSupportFlags () const ODRX_SEALED

Public Member Functions inherited from OdRxObject
	ODRX_HEAP_OPERATORS ()

	OdRxObject ()

virtual	~OdRxObject ()

virtual OdRxObject *	queryX (const OdRxClass *pClass) const

virtual OdRxObject *	x (const OdRxClass *pClass) const

virtual OdRxClass *	isA () const

virtual void	addRef ()=0

virtual void	release ()=0

virtual long	numRefs () const

bool	isKindOf (const OdRxClass *pClass) const

virtual OdRxObjectPtr	clone () const

virtual void	copyFrom (const OdRxObject *pSource)

virtual OdRx::Ordering	comparedTo (const OdRxObject *pOther) const

virtual bool	isEqualTo (const OdRxObject *pOther) const

Additional Inherited Members
Static Public Member Functions inherited from OdRxObject
static OdRxObjectPtr	cast (const OdRxObject *pointer)

static OdRxClass *	desc ()

Protected Member Functions inherited from OdGiDrawable
	OdGiDrawable ()

virtual OdUInt32	subSetAttributes (OdGiDrawableTraits *traits) const =0

virtual bool	subWorldDraw (OdGiWorldDraw *wd) const =0

virtual void	subViewportDraw (OdGiViewportDraw *vd) const =0

virtual OdUInt32	subViewportDrawLogicalFlags (OdGiViewportDraw *vd) const

virtual OdUInt32	subRegenSupportFlags () const

Detailed Description

Corresponding C++ library: Od_Tf <group OdTf_Classes>

Definition at line 204 of file TfObject.h.

Member Typedef Documentation

◆ ItemIndexType

typedef OdTfVariantArray::size_type OdTfObject::ItemIndexType

Definition at line 209 of file TfObject.h.

◆ PropertyIndexType

typedef OdTfPropertiesContainer::size_type OdTfObject::PropertyIndexType

Definition at line 208 of file TfObject.h.

Member Function Documentation

◆ addPersistentReactor()

virtual void OdTfObject::addPersistentReactor ( OdTfPersistentReactor * )

pure virtual

Adds the specified persistent reactor to this element's reactor list.

Parameters

elmId [in] Element ID of the persistent reactor.

Remarks: An element must be open OdBm::kForWrite in order to add a persistent reactor.

If the persistent reactor does not have an owner, it isn't saved with the drawing.

◆ addReactor()

virtual void OdTfObject::addReactor ( OdTfObjectReactor * pReactor )

pure virtual

Adds the specified transient reactor to this element's reactor list.

Parameters

pReactor [in] Pointer to the transient reactor object.

Remarks: An element must be open either OdBm::kForRead or OdBm::kForWrite in order to add a transient reactor.

◆ getOwner()

virtual const OdTfObject* OdTfObject::getOwner ( ) const

pure virtual

Gets the object's owner

◆ getPersistentReactors()

virtual void OdTfObject::getPersistentReactors ( OdTfPersistentReactorArray & elmIds )

pure virtual

Returns this element's persistent reactors.

Parameters

elmIds [out] Receives Element IDs of this element's persistent reactors.

◆ getProperty() [1/3]

virtual OdResult OdTfObject::getProperty	(	const OdString &	name,
		OdTfVariant &	value,
		const ItemIndexType	arrayIndex = `-1`,
		const OdTfClass *	pClass = `NULL`
	)		const

pure virtual

Gets the specified property value.

Parameters

name	[in] Property name.
value	[out] Property value.
arrayIndex	[in] if a property is of an array type, get the value at the given index.

◆ getProperty() [2/3]

virtual OdResult OdTfObject::getProperty	(	const OdTfProperty *	pPI,
		OdTfVariant &	value,
		const ItemIndexType	arrayIndex = `-1`
	)		const

pure virtual

◆ getProperty() [3/3]

virtual OdResult OdTfObject::getProperty	(	const PropertyIndexType	propertyIndex,
		OdTfVariant &	value,
		const ItemIndexType	arrayIndex = `-1`
	)		const

pure virtual

Gets the specified property value.

Parameters

propertyIndex	[in] Index of a property in a class field array.
value	[out] Property value.
arrayIndex	[in] if a property is of an array type, get the value at the given index.

◆ getTransientReactors()

virtual void OdTfObject::getTransientReactors ( OdTfObjectReactorArray & reactors )

pure virtual

Returns this element's transient reactors.

Parameters

reactors [out] Receives this element's transient reactors.

◆ hasPersistentReactor()

virtual bool OdTfObject::hasPersistentReactor ( OdTfPersistentReactor * ) const

pure virtual

This method returns true if elmId is the Element ID of a reactor attached to this element. Otherwise, it returns false.

Parameters

elmId [in] Element ID of the persistent reactor.

◆ removePersistentReactor()

virtual void OdTfObject::removePersistentReactor ( OdTfPersistentReactor * )

pure virtual

Removes the specified persistent reactor from this element's reactor list.

Parameters

elmId [in] Element ID of the persistent reactor.

Remarks: An element must be open OdBm::kForWrite in order to remove one of its persistent reactors.

◆ removeReactor()

virtual void OdTfObject::removeReactor ( OdTfObjectReactor * pReactor )

pure virtual

Removes the specified transient reactor from this element's reactor list.

Parameters

pReactor [in] Pointer to the transient reactor object.

Remarks: An element must be open either OdBm::kForRead or OdBm::kForWrite in order to remove a transient reactor.

◆ setProperty() [1/3]

virtual OdResult OdTfObject::setProperty	(	const OdString &	name,
		const OdTfVariant &	value,
		const ItemIndexType	arrayIndex = `-1`,
		const OdTfClass *	pClass = `NULL`
	)

pure virtual

Sets the specified property value.

Parameters

name	[in] Property name.
value	[in] New property value.
arrayIndex	[in] if a property is of an array type, set the value at the given index

◆ setProperty() [2/3]

virtual OdResult OdTfObject::setProperty	(	const OdTfProperty *	pPI,
		const OdTfVariant &	value,
		const ItemIndexType	arrayIndex = `-1`
	)

pure virtual

◆ setProperty() [3/3]

virtual OdResult OdTfObject::setProperty	(	const PropertyIndexType	propertyIndex,
		const OdTfVariant &	value,
		const ItemIndexType	arrayIndex = `-1`
	)

pure virtual

Sets the specified property value.

Parameters

propertyIndex	[in] Index of a property in a class field array.
value	[in] New property value.
arrayIndex	[in] if a property is of an array type, set the value at the given index

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

TfObject.h

Public Types

Public Member Functions

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ ItemIndexType

◆ PropertyIndexType

Member Function Documentation

◆ addPersistentReactor()

◆ addReactor()

◆ getOwner()

◆ getPersistentReactors()

◆ getProperty() [1/3]

◆ getProperty() [2/3]

◆ getProperty() [3/3]

◆ getTransientReactors()

◆ hasPersistentReactor()

◆ removePersistentReactor()

◆ removeReactor()

◆ setProperty() [1/3]

◆ setProperty() [2/3]

◆ setProperty() [3/3]