OdDgLightArea Class

Syntax

C++

class OdDgLightArea : public OdDgCellHeader3d, public OdDgLight;

Description

This class declares the methods for managing LT_Area type of lights.

Corresponding C++ library: TG_Db

Class Hierarchy

File: DgLight.h

Module: API Reference

Methods

Show:Inherited

No members matching the current filter

OdDgElement()	This is the overview for the OdDgElement constructor overload.
~OdDgElement	(Inherited from OdDgElement)

Enumerations

Class	element class: primary stands for most commonly used entities (like geometry primitives)
DragStat
ElementTypes	All types of elements... more
GripStat
OsnapMode
Type

Friends

Show:Inherited

No members matching the current filter

class OdDgElementImpl	(Inherited from OdDgElement)
class OdDgElementOverrule	(Inherited from OdDgElement)
class OdDgGeometryOverrule	(Inherited from OdDgElement)
class OdDgGripOverrule	(Inherited from OdDgElement)
class OdDgHighlightOverrule	(Inherited from OdDgElement)
class OdDgNamedGroupHeader	(Inherited from OdDgElement)
class OdDgOsnapOverrule	(Inherited from OdDgElement)
class OdDgTransformOverrule	(Inherited from OdDgElement)
class OdDgVisibilityOverrule	(Inherited from OdDgGraphicsElement)

Methods

Show:Inherited

No members matching the current filter

ODDG_DECLARE_MEMBERS_INTERNAL
addExtendedParam	(Inherited from OdDgLight)
addExtendedParam
addLinkage(OdUInt16, OdBinaryData const&, bool)	This is the overview for the addLinkage method overload.
addPersistentReactor	Adds the specified persistent reactor to this element's reactor list. (Inherited from OdDgElement)
addReactor	Adds the specified transient reactor to this element's reactor list. (Inherited from OdDgElement)
addRef	OdRxObject overridden (Inherited from OdDgElement)
addXAttribute	Adds the XAttribute with specified handler ID. (Inherited from OdDgElement)
appendToOwner	This function appends this object to the specified owner object. (Inherited from OdDgElement)
applyPartialUndo	(Inherited from OdDgElement)
assertNotifyEnabled	Throws an exception if this object is not open OdDg::kForNotify. (Inherited from OdDgElement)
assertReadEnabled	Throws an exception if this object is not open OdDg::kForRead. (Inherited from OdDgElement)
assertWriteEnabled	Throws an exception if this object is not open OdDg::kForWrite, and controls automatic undo and notification of modifications. (Inherited from OdDgElement)
cloneMeForDragging	Returns the cloneMeForDragging flag for this entity. (Inherited from OdDgElement)
closed	Notification function called immediately before an element is closed. (Inherited from OdDgElement)
composeForLoad	(Inherited from OdDgElement)
copied	Notification function called whenever the notifying element has had its clone() member function called. (Inherited from OdDgElement)
copyFieldReferencesForWBlockClone	Writes object references of this object during wblock clone. (Inherited from OdDgElement)
copyFrom	Copies the contents of the specified object into this object when possible. (Inherited from OdDgElement)
copyLinkageReferencesForWBlockClone	(Inherited from OdDgElement)
copyXAttributeReferencesForWBlockClone	(Inherited from OdDgElement)
database	Returns the OdDgDatabase that contains this object. (Inherited from OdDgElement)
decomposeForSave	Determines the behavior for custom objects when saving. (Inherited from OdDgElement)
deepClone	Performs a deep clone of this object. (Inherited from OdDgElement)
deleteExtendedParam(const OdString&)	This is the overview for the deleteExtendedParam method overload.
deleteExtendedParam(const OdString&)	This is the overview for the deleteExtendedParam method overload.
dgnIn	Reads the DGN format data of this object from the specified file. (Inherited from OdDgElement)
dgnInFields	Reads the DGN data of this object. (Inherited from OdDgElement)
dgnOut	Writes the DGN format data of this object to the specified filer. (Inherited from OdDgElement)
dgnOutFields	Writes the DGN data of this object. (Inherited from OdDgElement)
disableUndoRecording	Controls the undo recording of this object in OdDgDatabase. (Inherited from OdDgElement)
downgradeOpen	Downgrades this object from OdDg::kForWrite to OdDg::kForRead, and returns isReadEnabled(); (Inherited from OdDgElement)
dragStatus	Notification function called when this entity is involved in a drag operation. (Inherited from OdDgElement)
drawableType
elementId	Returns the Object ID of this object. (Inherited from OdDgElement)
erase	Sets the erased mode of this object. (Inherited from OdDgElement)
erased	Notification function called whenever an element has been erased or unerased. (Inherited from OdDgElement)
explode	(Inherited from OdDgElement)
explodeGeometry	(Inherited from OdDgElement)
explodeGeometryToBlock	(Inherited from OdDgElement)
explodeToBlock	(Inherited from OdDgElement)
get3dFormatFlag	(Inherited from OdDgGraphicsElement)
getAttenuateOnFlag
getAttenuationDistance
getBrightness
getClass	The method returns the element class property. See Class enumeration ocumentation for more details. (Inherited from OdDgGraphicsElement)
getColor	details This ones are similar to get/setColorIndex() but use color tables to find/create indexed colors. (Inherited from OdDgGraphicsElement)
getColorBlue
getColorGreen
getColorIndex	Operate with color indices. See OdDg::ColorIndexConstants for some special values. See OdDgColorTable for the methods to translate indices to RGB values and back (Inherited from OdDgGraphicsElement)
getColorRed
getElementFillFlag	Operate with element fills. (Inherited from OdDgGraphicsElement)
getElementSubType	Returns the element subtype. (Inherited from OdDgElement)
getElementType	Returns the element type. (Inherited from OdDgElement)
getExtendedParam(const OdString&)	This is the overview for the getExtendedParam method overload.
getExtendedParam(const OdString&)	This is the overview for the getExtendedParam method overload.
getExtendedParamCount	(Inherited from OdDgLight)
getExtendedParamCount
getFillColorIndex	(Inherited from OdDgGraphicsElement)
getFillType	(Inherited from OdDgGraphicsElement)
getGeomExtents(const OdDgElementId&, OdGeExtents3d&)	This is the overview for the getGeomExtents method overload.
getGeometryModified	(Inherited from OdDgElement)
getGradientFill	(Inherited from OdDgGraphicsElement)
getGraphicsGroupEntryId	The method returns the entry id of the graphics group. (Inherited from OdDgGraphicsElement)
getGripPoints(OdDgGripDataPtrArray&, const double, const int, const OdGeVector3d&, const int)	This is the overview for the getGripPoints method overload.
getHatchPattern	Operate with element hatch pattern. (Inherited from OdDgGraphicsElement)
getHbitFlag	The H-bit means the following:... more (Inherited from OdDgGraphicsElement)
getIESDataOnFlag
getIESFilename
getIESRotation
getIntensity
getInvisibleFlag	Returns the visibility status of this graphic element. (Inherited from OdDgGraphicsElement)
getLastModifiedTime()	This is the overview for the getLastModifiedTime method overload.
getLevelEntryId	details (Inherited from OdDgGraphicsElement)
getLevelId	(Inherited from OdDgGraphicsElement)
getLightName	(Inherited from OdDgLight)
getLightName
getLightType	(Inherited from OdDgLight)
getLightType
getLineStyleEntryId	Operate with line styles. See OdDg::LineStyleConstants for some special values. (Inherited from OdDgGraphicsElement)
getLineStyleId	(Inherited from OdDgGraphicsElement)
getLineWeight	Operate with line weights. See OdDg::LineWeightConstants for some special values. (Inherited from OdDgGraphicsElement)
getLinkages(OdRxObjectPtrArray&)	This is the overview for the getLinkages method overload.
getLockedFlag	Returns true if and only if this element is marked as locked. (Inherited from OdDgElement)
getMaterial	(Inherited from OdDgGraphicsElement)
getName
getNonPlanarFlag	(Inherited from OdDgGraphicsElement)
getNotSnappableFlag	(Inherited from OdDgGraphicsElement)
getOnFlag	(Inherited from OdDgLight)
getOnFlag
getOsnapPoints(OdDgElement::OsnapMode, OdGsMarker, const OdGePoint3d&, const OdGePoint3d&, const OdGeMatrix3d&, OdGePoint3dArray&)	This is the overview for the getOsnapPoints method overload.
getPersistentReactors	Returns this element's persistent reactors. (Inherited from OdDgElement)
getPriority	(Inherited from OdDgGraphicsElement)
getSampleCount
getShadowOnFlag
getShadowResolution
getStretchPoints	(Inherited from OdDgElement)
getStringLinkage	Returns the String Linkage value. (Inherited from OdDgElement)
getThickness	(Inherited from OdDgGraphicsElement)
getThicknessDirection	(Inherited from OdDgGraphicsElement)
getTransformedCopy	Creates a copy of this element, and applies the supplied transformation to the newly created copy. (Inherited from OdDgElement)
getTransientReactors	Returns this element's transient reactors. (Inherited from OdDgElement)
getTransparency	Returns the transparency setting of this entity. (Inherited from OdDgGraphicsElement)
getViewIndependentFlag	(Inherited from OdDgGraphicsElement)
getXAttributes(OdRxObjectPtrArray&)	This is the overview for the getXAttributes method overload.
getXDataLinkage	Returns the XData Linkage value. (Inherited from OdDgElement)
goodbye	Notification function called just before an element is deleted from memory. (Inherited from OdDgElement)
gripStatus	Notification function called when this entity is involved in a grip operation. (Inherited from OdDgElement)
gsNode	(Inherited from OdDgElement)
handOverTo	Replaces this database -resident (DBRO) object with the specified non- database -resident (NDBRO) object, while retaining this object's elementId, handle, owner, and reactor list. (Inherited from OdDgElement)
hasPersistentReactor	This method returns true if elmId is the Element ID of a reactor attached to this element. Otherwise, it returns false. (Inherited from OdDgElement)
hideMeForDragging	Returns the hideMeForDragging flag for this entity. (Inherited from OdDgElement)
highlight	(Inherited from OdDgElement)
id	(Inherited from OdDgElement)
intersectWith(const OdDgGraphicsElement*, OdDg::OdDgIntersectType, const OdGePlane&, OdGePoint3dArray&)	This is the overview for the intersectWith method overload.
isContentSnappable	(Inherited from OdDgElement)
isDBRO	Returns true if and only this object is a database -resident object. (Inherited from OdDgElement)
isErased	Returns true if and only if this object is marked as erased. (Inherited from OdDgElement)
isMaterialPropertyAvailble	Operate with materials. (Inherited from OdDgGraphicsElement)
isModifiedGraphics	Returns true if and only if an object derived from OdDbEntity has been modified. (Inherited from OdDgElement)
isNewObject	Returns true if and only if this object has not been closed since it was created. (Inherited from OdDgElement)
isNotifyEnabled	Returns true if and only if this object is open OdDg::kForNotify. (Inherited from OdDgElement)
isOdDgElementIdsInFlux	Returns true if and only if this object's Object ID is not valid because the OdDgElement::subDeepClone or OdDgElement::subWblockClone() have yet to be completed. (Inherited from OdDgElement)
isPersistent	(Inherited from OdDgElement)
isReadEnabled	Returns true if and only if this object is open OdDg::kForRead. (Inherited from OdDgElement)
isUndoing	Returns true if and only if this object is taking part in an Undo operation. (Inherited from OdDgElement)
isWriteEnabled	Returns true if and only if this object is open OdDg::kForWrite. (Inherited from OdDgElement)
list	(Inherited from OdDgGraphicsElement)
modified	Notification function called whenever an element is opened OdDg::kForWrite, a function has been called that could modify the contents of this element, and this element is now being closed. (Inherited from OdDgElement)
modifiedGeometry	Notification function called whenever an geometry of element derived from OdDgGraphicsElement is modified. (Inherited from OdDgElement)
modifiedGraphics	Notification function called whenever an element derived from OdDgGraphicsElement is modified. (Inherited from OdDgElement)
modifiedLinkages	Notification function called whenever the attribute linkages has been written to the notifying element. (Inherited from OdDgElement)
modifyUndone	Notification function called whenever the notifying element is in the midst an Undo operation that is undoing modifications. (Inherited from OdDgElement)
moveGripPointsAt(const OdDgVoidPtrArray&, const OdGeVector3d&, int)	This is the overview for the moveGripPointsAt method overload.
moveStretchPointsAt	Moves the specified stretch points of this entity. (Inherited from OdDgElement)
needPostprocessingAfterMTLoading	If true then composeForLoad will be called second time in single thread mode after multithread loading. (Inherited from OdDgElement)
numRefs	(Inherited from OdDgElement)
openedForModify	Notification function called whenever an element is opened for modify OdDg::kForWrite. (Inherited from OdDgElement)
ownerId	Returns the element ID of this element's owner. (Inherited from OdDgElement)
reappended	Notification function called whenever a Redo process processes the reappending of the notifying element to the database. (Inherited from OdDgElement)
recordGraphicsModified	Sets the bit flag indicating the entity's geometry is changed. (Inherited from OdDgElement)
recordGraphicsModified	Sets the bit flag indicating the element's geometry is changed. (Inherited from OdDgGraphicsElement)
recvPropagateModify	Allows a subelement of a complex element to notify its root element that it has been changed. (Inherited from OdDgElement)
release	(Inherited from OdDgElement)
removeLinkages	Removes the linkages with specified application ID. (Inherited from OdDgElement)
removePersistentReactor	Removes the specified persistent reactor from this element's reactor list. (Inherited from OdDgElement)
removeReactor	Removes the specified transient reactor from this element's reactor list. (Inherited from OdDgElement)
removeXAttributes	Removes the XAttributes with specified handler ID. (Inherited from OdDgElement)
setAttenuateOnFlag
setAttenuationDistance
setBrightness
setClass	The method changes the element class property. See Class enumeration ocumentation for more details. (Inherited from OdDgGraphicsElement)
setColor(ODCOLORREF, bool)	This is the overview for the setColor method overload.
setColorBlue
setColorGreen
setColorIndex	(Inherited from OdDgGraphicsElement)
setColorRed
setDatabaseDefaults	Applies the default properties of the specified database to this entity. (Inherited from OdDgElement)
setDefaultValues	(Inherited from OdDgLight)
setDefaultValues
setExtendedParam(const OdString&, const OdDgLightParam&)	This is the overview for the setExtendedParam method overload.
setExtendedParam(const OdString&, const OdDgLightParam&)	This is the overview for the setExtendedParam method overload.
setFillColor	(Inherited from OdDgGraphicsElement)
setFillType	(Inherited from OdDgGraphicsElement)
setGeometryModified	(Inherited from OdDgElement)
setGradientFill	(Inherited from OdDgGraphicsElement)
setGraphicsGroupEntryId	The method changes the graphics group entry id of the current element. (Inherited from OdDgGraphicsElement)
setGsNode	(Inherited from OdDgElement)
setHatchPattern	(Inherited from OdDgGraphicsElement)
setHbitFlag	(Inherited from OdDgGraphicsElement)
setIESDataOnFlag
setIESFilename
setIESRotation
setIntensity
setInvisibleFlag	Sets the visibility status of this graphic element. (Inherited from OdDgGraphicsElement)
setLastModifiedTime	Set the time of the last modification. (Inherited from OdDgElement)
setLevelEntryId	(Inherited from OdDgGraphicsElement)
setLevelId	(Inherited from OdDgGraphicsElement)
setLightName	(Inherited from OdDgLight)
setLightName
setLineStyleEntryId	(Inherited from OdDgGraphicsElement)
setLineStyleId	(Inherited from OdDgGraphicsElement)
setLineWeight	(Inherited from OdDgGraphicsElement)
setLinkages	Sets the linkages with specified application ID. (Inherited from OdDgElement)
setLockedFlag	(Inherited from OdDgElement)
setMaterial(const OdDgElementId&)	This is the overview for the setMaterial method overload.
setName
setNonPlanarFlag	(Inherited from OdDgGraphicsElement)
setNotSnappableFlag	(Inherited from OdDgGraphicsElement)
setOdDgElementIdsInFlux	Called on a new created cloned object to indicate that its Object ID is not valid. (Inherited from OdDgElement)
setOnFlag	(Inherited from OdDgLight)
setOnFlag
setOwnerId	Sets this element's ownerId data member. (Inherited from OdDgElement)
setPriority	(Inherited from OdDgGraphicsElement)
setPropertiesFrom	Copies the properties from the specified entity to this entity. (Inherited from OdDgElement)
setSampleCount
setShadowOnFlag
setShadowResolution
setStringLinkage	Sets the String Linkage value. (Inherited from OdDgElement)
setThickness	(Inherited from OdDgGraphicsElement)
setThicknessDirection	(Inherited from OdDgGraphicsElement)
setTransparency	Sets the transparency setting of this entity, and returns eOk if successful. (Inherited from OdDgGraphicsElement)
setViewIndependentFlag	(Inherited from OdDgGraphicsElement)
setXAttributes	Sets the XAttributes with specified handler ID. (Inherited from OdDgElement)
setXDataLinkage	Sets the XData Linkage value. (Inherited from OdDgElement)
subClose	Called as the first operation as this object is being closed, for database -resident objects only. When overriding this function: 1) If the OdDgElement's state is incorrect, return something other than eOk. 2) If the parent class's subClose() returns anything other than eOk, immediately return it. 3) If other actions are required before close, do them. 4) Return eOk. If you must make changes to this object's state, either make them after step 2, or roll them back if step 2 returns false. The default implementation of this function does nothing but return eOk. This function can be overridden in... more (Inherited from OdDgElement)
subElementModified	Notification function called whenever a method of the specified subelement has called assertWriteEnabled() (Inherited from OdDgElement)
subErase	Called as the first operation as this object is being erased or unerased. (Inherited from OdDgElement)
subErase	Called as the first operation as this object is being erased or unerased. (Inherited from OdDgGraphicsElement)
subGetGeomExtents(const OdDgElementId&, OdGeExtents3d&)	This is the overview for the subGetGeomExtents method overload.
subGetTransformedCopy	(Inherited from OdDgElement)
subHandOverTo	Called as the first operation of the handOverTo function. (Inherited from OdDgElement)
subIntersectWith(const OdDgGraphicsElement*, OdDg::OdDgIntersectType, const OdGePlane&, OdGePoint3dArray&)	This is the overview for the subIntersectWith method overload.
subList	(Inherited from OdDgGraphicsElement)
subOpen	Notification function called by the ODA Drawings API for DGN immediately before an object is opened. (Inherited from OdDgElement)
subSetAttributes	(Inherited from OdDgElement)
subSetAttributes	OdGiDrawable overridden (Inherited from OdDgGraphicsElement)
subSetAttributes	OdGiDrawable overridden
subSetDatabaseDefaults	Called by setDatabaseDefaults() after the values are set. (Inherited from OdDgElement)
subSetDatabaseDefaults	Called by setDatabaseDefaults() after the values are set. (Inherited from OdDgGraphicsElement)
subSwapIdWith	Called as the first operation of swapIdWith (Inherited from OdDgElement)
subTransformBy	(Inherited from OdDgElement)
subViewportDraw	(Inherited from OdDgElement)
subWorldDraw	(Inherited from OdDgElement)
subWorldDraw	it should be called by any object that could have common auxiliary drawable properties (e.c., patterns) (Inherited from OdDgGraphicsElement)
swapIdWith	Swaps the elementIDs, and handles between this object and another object. (Inherited from OdDgElement)
transformBy	Applies the specified 3D transformation matrix to this entity. (Inherited from OdDgElement)
unappended	Notification function called whenever the Undo process processes the appending of the notifying element to the database. (Inherited from OdDgElement)
undoFiler	Returns the undo filer associated with this object. (Inherited from OdDgElement)
updateFieldReferencesForWBlockClone	(Inherited from OdDgElement)
updateLinkageReferencesForWBlockClone	(Inherited from OdDgElement)
updateXAttributeReferencesForWBlockClone	(Inherited from OdDgElement)
upgradeOpen	Upgrades this object from OdDg::kForRead to OdDg::kForWrite if there is only one reader, and returns isWriteEnabled(); (Inherited from OdDgElement)
wblockClone	Performs a shallow clone of this object. (Inherited from OdDgElement)
xmitPropagateModify	Allows a subelement of a complex element to notify its root element that it has been changed. (Inherited from OdDgElement)

Links

OdDgLightArea Methods

Relief for ODA Team in Ukraine