This class represents a placeholder for all generic light properties. Corresponding C++ library: SCENEOE
File: DbLight.h
Module: API Reference
(Inherited from OdDbEntity) | |
Default constructor for the OdDbLight class. Creates an object with default properties of the OdDbLightImpl object. | |
(Inherited from OdDbObject) |
Display types for glyphs. | |
Lamp color presets. | |
The lamp color type. | |
| |
|
(Inherited from OdDbEntity) | |
(Inherited from OdDbEntity) | |
(Inherited from OdDbEntity) | |
(Inherited from OdDbObject) | |
(Inherited from OdDbObject) | |
(Inherited from OdDbEntity) | |
(Inherited from OdDbEntity) | |
(Inherited from OdDbObject) | |
(Inherited from OdDbEntity) | |
(Inherited from OdDbObject) | |
(Inherited from OdDbEntity) | |
(Inherited from OdDbEntity) |
(Inherited from OdDbEntity) | |
| |
(Inherited from OdDbObject) | |
Adds the specified persistent reactor to this object's reactor list. (Inherited from OdDbObject) | |
Adds the specified transient reactor to this object's reactor list. (Inherited from OdDbObject) | |
Increments the reference count of this object. (Inherited from OdDbObject) | |
(Inherited from OdDbEntity) | |
This function appends this object to the specified owner object during the deep or wblock clone operation. (Inherited from OdDbEntity) | |
This function appends this object to the specified owner object during the deep or wblock clone operation. (Inherited from OdDbObject) | |
Notification function called each time an Undo operation is performed this object is using partial Undo. (Inherited from OdDbEntity) | |
Notification function called each time an Undo operation is performed this object is using partial Undo. (Inherited from OdDbObject) | |
Throws an exception if this object is not open OdDb::kForNotify. (Inherited from OdDbObject) | |
Throws an exception if this object is not open OdDb::kForRead. (Inherited from OdDbObject) | |
Throws an exception if this object is not open OdDb::kForWrite, and controls automatic undo and notification of modifications. (Inherited from OdDbObject) | |
Perform an audit operation on this object. (Inherited from OdDbObject) | |
Returns the Object ID of the OdDbBlockTableRecord that owns this entity. (Inherited from OdDbEntity) | |
This is the overview for the boundingBoxIntersectWith method overload. | |
Returns the CastShadows flag for this entity.. (Inherited from OdDbEntity) | |
Returns the cloneMeForDragging flag for this entity. (Inherited from OdDbEntity) | |
Returns the CollisionType for this entity. (Inherited from OdDbEntity) | |
Returns the color information of this entity as an OdCmColor instance. (Inherited from OdDbEntity) | |
Returns the Object ID of the OdDbColor object referenced by this entity. (Inherited from OdDbEntity) | |
Returns the color index of this entity (DXF 62). (Inherited from OdDbEntity) | |
After loading from file, performs necessary actions which require accessing other Database objects. For example, processing round-trip data. (Inherited from OdDbObject) | |
The method should be called from *decomposeForSave()* of custom container objects for owned child objects. It calls child's decomposeForSave() method plus performs other required actions (handOverTo, exchanging XData, etc.) (Inherited from OdDbObject) | |
Notification function called whenever the notifying object has had its clone() member function called. (Inherited from OdDbObject) | |
Copies the contents of the specified object into this object when possible. (Inherited from OdDbEntity) | |
Copies the contents of the specified object into this object when possible. (Inherited from OdDbObject) | |
Creates an OdDbDictionary extension dictionary of this object. (Inherited from OdDbObject) | |
Creates or retrieves the specified Xrecord in this object's extension dictionary. (Inherited from OdDbObject) | |
Returns the OdDbDatabase that contains this object. (Inherited from OdDbObject) | |
This is the overview for the decomposeForSave method overload. | |
Performs a deep clone of this object. (Inherited from OdDbObject) | |
(Inherited from OdDbEntity) | |
Controls the undo recording of this object in OdDbDatabase. (Inherited from OdDbObject) | |
Downgrades this object from OdDb::kForWrite to OdDb::kForRead (Inherited from OdDbObject) | |
Notification function called when this entity is involved in a drag operation. (Inherited from OdDbEntity) | |
Returns a pointer to the OdGiDrawable for the object. If the object doesn't have an associated OdGiDrawable object, this function returns NULL. (Inherited from OdDbEntity) | |
Returns a pointer to the OdGiDrawable for the object. If the object doesn't have an associated OdGiDrawable object, this function returns NULL. (Inherited from OdDbObject) | |
Retrieves the type of this drawable. | |
Reads the .dwg file format data of this object from the specified file. (Inherited from OdDbObject) | |
Reads the .dwg file data of this object. (Inherited from OdDbEntity) | |
Reads the .dwg file data of this object. | |
Reads the .dwg file data of this object. (Inherited from OdDbObject) | |
Writes the .dwg file format data of this object to the specified filer. (Inherited from OdDbObject) | |
Writes the .dwg file data of this object. (Inherited from OdDbEntity) | |
Writes the .dwg file data of this object. | |
Writes the .dwg file data of this object. (Inherited from OdDbObject) | |
Reads the DXF format data of this object from the specified filer. (Inherited from OdDbEntity) | |
Reads the DXF format data of this object from the specified filer. (Inherited from OdDbObject) | |
Reads the DXF data of this object. (Inherited from OdDbEntity) | |
Reads the .dxf file data of this object. | |
Reads the DXF data of this object. (Inherited from OdDbObject) | |
Reads the DXF R12 format data of this object. (Inherited from OdDbEntity) | |
Reads the DXF R12 format data of this object. (Inherited from OdDbObject) | |
Writes the DXF format data of this object to the specified filer. (Inherited from OdDbEntity) | |
Writes the DXF format data of this object to the specified filer. (Inherited from OdDbObject) | |
Writes the DXF data of this object. (Inherited from OdDbEntity) | |
Writes the .dxf file data of this object. | |
Writes the DXF data of this object. (Inherited from OdDbObject) | |
Writes the DXF data of this object. (Inherited from OdDbEntity) | |
Writes the DXF data of this object. (Inherited from OdDbObject) | |
Returns the OdCmEntityColor settings of this object. (Inherited from OdDbEntity) | |
Sets the erased mode of this object. (Inherited from OdDbObject) | |
Notification function called whenever an object has been erased or unerased. (Inherited from OdDbObject) | |
Explodes this entity into a set of simpler entities. (Inherited from OdDbEntity) | |
Explodes this entity into a set of simpler entities. (Inherited from OdDbEntity) | |
Explodes this entity into a set of simpler entities, and adds them to the specified block. (Inherited from OdDbEntity) | |
Explodes this entity into a set of simpler entities, and adds them to the specified block table record. (Inherited from OdDbEntity) | |
Returns the Object ID of this object's extension dictionary. (Inherited from OdDbObject) | |
Retrieves the cone angle that produces the light falloff. | |
Returns the CLSID value associated with this object. (Inherited from OdDbObject) | |
Is applicable for compound objects only which return the kDrawableIsCompoundObject flag from subSetAttributes(). The matrix returned is the one that is passed to pushModelTransform before rendering nested objects. Default implementation returns OdDb::eNotApplicable and the identity matrix in xM. (Inherited from OdDbEntity) | |
Returns the persistent handle of this database object. (Inherited from OdDbObject) | |
Returns the entity coordinate system matrix. (Inherited from OdDbEntity) | |
This is the overview for the getField method overload. | |
This is the overview for the getFieldDictionary method overload. | |
(Inherited from OdDbEntity) | |
This is the overview for the getGripPoints method overload. | |
(Inherited from OdDbEntity) | |
(Inherited from OdDbEntity) | |
Returns the drawing and maintenance release version into which this object must be stored. (Inherited from OdDbObject) | |
This is the overview for the getOsnapPoints method overload. | |
Returns Object IDs of this object's persistent reactors. (Inherited from OdDbObject) | |
Returns the plane that contains this entity. (Inherited from OdDbEntity) | |
Returns the PlotStyleName of this entity. (Inherited from OdDbEntity) | |
Returns all stretch points of this entity. (Inherited from OdDbEntity) | |
(Inherited from OdDbEntity) | |
(Inherited from OdDbEntity) | |
(Inherited from OdDbEntity) | |
Creates a copy of this entity, and applies the supplied transformation to the newly created copy. (Inherited from OdDbEntity) | |
Returns this object's transient reactors. (Inherited from OdDbObject) | |
Retrieves the glyph display type of this light. | |
Notification function called just before an object is deleted from memory. (Inherited from OdDbObject) | |
Notification function called when this entity is involved in a grip operation. (Inherited from OdDbEntity) | |
Returns the OdGsCache of an OdGiDrawable object. (Inherited from OdDbObject) | |
Replaces this database -resident (DBRO) object with the specified non- database -resident (NDBRO) object, while retaining this object's objectId, handle, owner, and reactor list. (Inherited from OdDbObject) | |
Returns the persistent handle of this database object. (Inherited from OdDbObject) | |
Returns true if and only if this object has fields. (Inherited from OdDbObject) | |
This method returns true if objId is the Object ID of a reactor attached to this object. Otherwise, it returns false. (Inherited from OdDbObject) | |
Returns true if and only if this object has its bit set to override the filer version. (Inherited from OdDbObject) | |
Checks whether this light displays a target grip to orient this light. | |
Returns the hideMeForDragging flag for this entity. (Inherited from OdDbEntity) | |
(Inherited from OdDbEntity) | |
Retrieves the cone angle that produces the brightest part of the beam (hotspot) of this light. | |
Returns the database ID corresponding to this object. (Inherited from OdDbObject) | |
Retrieves the illuminance distance of the light. | |
Retrieves the intensity of this light. | |
This is the overview for the intersectWith method overload. | |
Returns true if and only if this object is a proxy object or entity. (Inherited from OdDbObject) | |
(Inherited from OdDbEntity) | |
Returns true if and only this object is a database -resident object. (Inherited from OdDbObject) | |
Returns true if and only if this object's erased status has been toggled since it was opened. (Inherited from OdDbObject) | |
Returns true if and only if this object is marked as erased. (Inherited from OdDbObject) | |
Returns true if and only if this object's assertWriteEnabled() has been called since it was opened. (Inherited from OdDbObject) | |
Returns true if and only if an object derived from OdDbEntity has been modified. (Inherited from OdDbObject) | |
Returns true if and only this object's assertWriteEnabled() and setXData() have been called since it was opened. (Inherited from OdDbObject) | |
Returns true if and only if this object has not been closed since it was created. (Inherited from OdDbObject) | |
Returns true if and only if this object is open OdDb::kForNotify. (Inherited from OdDbObject) | |
Returns true if and only if this object is sending notification. (Inherited from OdDbObject) | |
Returns true if and only if this object's Object ID is not valid because the OdDbObject::subDeepClone or OdDbObject::subWblockClone() have yet to be completed. (Inherited from OdDbObject) | |
Checks whether this light is enabled. | |
Return true if and only if this object is database -resident (DBRO). (Inherited from OdDbObject) | |
Returns true if and only if this entity is planar. (Inherited from OdDbEntity) | |
Checks whether this light is shown during plotting. | |
Returns true if and only if this object is open OdDb::kForRead. (Inherited from OdDbObject) | |
Returns true if and only if a call to close would completely close this object at this time. (Inherited from OdDbObject) | |
Returns true if and only if this object is taking part in an Undo operation. (Inherited from OdDbObject) | |
Returns true if and only if this object is open OdDb::kForWrite. (Inherited from OdDbObject) | |
Retrieves the preset lamp color of this light. | |
Retrieves the RGB value of the light's lamp color. | |
Retrieves the Kelvin color temperature of the light if the lamp color type is kKelvin. | |
Retrieves the lamp color type of the light that indicates how the lamp color of the light is specified (Kelvin color temperature or a preset lamp color). | |
Returns the name of the layer referenced by this entity (DXF 8). (Inherited from OdDbEntity) | |
Returns the Object ID of the OdDbLayerTableRecord referenced by this entity. (Inherited from OdDbEntity) | |
Retrieves the attenuation parameters of this light. | |
Retrieves the color of this light. | |
Retrieves the direction of a distant light. | |
Retrieves the type of this light. | |
Returns the lineweight property of this entity (DXF 370). (Inherited from OdDbEntity) | |
Returns the name of the linetype referenced by this entity (DXF 6). (Inherited from OdDbEntity) | |
Returns the Object ID of the linetype referenced by this entity (DXF 6). (Inherited from OdDbEntity) | |
Returns the linetype scale of this entity (DXF 48). (Inherited from OdDbEntity) | |
This method is triggered by the standard LIST command and is to be display the dxf format contents of the entity to the display. (Inherited from OdDbEntity) | |
Returns the name of the material referenced by this entity (DXF 347). (Inherited from OdDbEntity) | |
Returns the Object ID of the material referenced by this entity (DXF 347). (Inherited from OdDbEntity) | |
Returns OdGiMapper used to map a material to the entity. Returns null if the default mapper is used. (Inherited from OdDbEntity) | |
Returns the merge style of this object. (Inherited from OdDbObject) | |
Notification function called whenever an object is opened OdDb::kForWrite, a function has been called that could modify the contents of this object, and this object is now being closed. (Inherited from OdDbObject) | |
Notification function called whenever an object derived from OdDbEntity is modified. (Inherited from OdDbObject) | |
Notification function called whenever the XData has been written to the notifying object. (Inherited from OdDbObject) | |
Notification function called whenever the notifying object is in the midst an Undo operation that is undoing modifications. (Inherited from OdDbObject) | |
This is the overview for the moveGripPointsAt method overload. | |
(Inherited from OdDbEntity) | |
Moves the specified stretch points of this entity. (Inherited from OdDbEntity) | |
Retrieves the light name. | |
Returns the reference count of this object. (Inherited from OdDbObject) | |
Notification function called immediately before an object is closed. (Inherited from OdDbObject) | |
Returns the Object ID of this object. (Inherited from OdDbObject) | |
Notification function called whenever an object is opened for modify OdDb::kForWrite. (Inherited from OdDbObject) | |
Returns the Object ID of this object's owner. (Inherited from OdDbObject) | |
Retrieves the physical intensity of the light. The units are based on the physical intensity method (candela, lumen or lux). | |
Retrieves the physical intensity method of this light that indicates how the physical intensity of the light is calculated (by peak intensity, by flux or by illuminance). | |
Returns the name of the plotStyleName string associated with this entity (DXF 390). (Inherited from OdDbEntity) | |
Retrieves the position for point light and spot light sources. | |
Notification function called whenever a Redo process processes the reappending of the notifying object to the database. (Inherited from OdDbObject) | |
Returns the ReceiveShadows flag for this entity.. (Inherited from OdDbEntity) | |
Sets the bit flag indicating the entity's geometry is changed. (Inherited from OdDbEntity) | |
Allows a subobject of a complex object to notify its root object that it has been changed. (Inherited from OdDbObject) | |
Decrements the reference count of this object. (Inherited from OdDbObject) | |
Releases and erases this object's extension dictionary if it exists and is empty. (Inherited from OdDbObject) | |
This is the overview for the removeField method overload. | |
Removes the specified persistent reactor from this object's reactor list. (Inherited from OdDbObject) | |
Removes the specified transient reactor from this object's reactor list. (Inherited from OdDbObject) | |
Retrieves the final color of the light as a result of mixing the lamp color and the filter color. | |
Creates a geometric representation of this entity for saving proxy graphics or converting to previous formats. (Inherited from OdDbEntity) | |
!DOM (Inherited from OdDbObject) | |
Controls the CastShadows flag for this entity. (Inherited from OdDbEntity) | |
Sets the color information of this entity from an OdCmColor instance. (Inherited from OdDbEntity) | |
Assigns the specified OdDbColor object to this entity. (Inherited from OdDbEntity) | |
Sets the color index of this entity (DXF 62). (Inherited from OdDbEntity) | |
Applies the default properties of the specified database to this entity. (Inherited from OdDbEntity) | |
Adds the specified field to the field dictionary of this object. (Inherited from OdDbObject) | |
Specifies the display type of the glyph for this light. | |
Assigns the specified OdGsCache to the calling object. (Inherited from OdDbObject) | |
Controls the flag specifying that this object overrides the save filer version. (Inherited from OdDbObject) | |
Specifies whether this light should display a target grip to orient this light. | |
Specifies the hotspot and falloff for the cone of the directional light. | |
Specifies the illuminance distance of the light. | |
Specifies the intensity of this light. | |
Specifies whether this light is shown during plotting. | |
Sets the lamp color of this light from a preset. | |
Sets the lamp color of this light as an RGB color value. | |
Sets the Kelvin color temperature of the light. | |
Specifies the lamp color type of the light that indicates how the lamp color of the light is specified (Kelvin color temperature or a preset lamp color). | |
This is the overview for the setLayer method overload. | |
Specifies the attenuation parameters for this light. | |
Specifies the color of this light. | |
Specifies the direction of a distant light. | |
Sets the type of this light. | |
Sets the lineweight property of this entity (DXF 370). (Inherited from OdDbEntity) | |
This is the overview for the setLinetype method overload. | |
Sets the Linetype scale of this entity (DXF 48). (Inherited from OdDbEntity) | |
This is the overview for the setMaterial method overload. | |
Sets the mapper used to map a material to the entity. (Inherited from OdDbEntity) | |
Sets a light name. | |
Called on a new created cloned object to indicate that its Object ID is not valid. (Inherited from OdDbObject) | |
Switches this light on or off. | |
Sets this object's ownerId data member. (Inherited from OdDbObject) | |
Specifies the physical intensity of the light. | |
Specifies the physical intensity method for this light that indicates how the physical intensity of the light is specified. | |
This is the overview for the setPlotStyleName method overload. | |
Specifies the position for point light and spot light sources. | |
Copies the properties from the specified entity to this entity. (Inherited from OdDbEntity) | |
Controls the Receivehadows flag for this entity. (Inherited from OdDbEntity) | |
Specifies the shadow parameters for this light. | |
Specifies the target location of a light. | |
Sets the temporary (not saved to file) visibility status of this entity. (Inherited from OdDbEntity) | |
Sets the transparency setting of this entity, and returns eOk if successful. (Inherited from OdDbEntity) | |
Sets the visibility status of this entity (DXF 60). (Inherited from OdDbEntity) | |
Sets the *visual style* to be used by this entity. (Inherited from OdDbEntity) | |
Specifies the full path to the file that stores the light's goniometric data (.ies file). | |
Specifies the rotation offset used to orient the goniometric data relative to the light orientation. The angle for each axis is 0.0. | |
Sets the XData of this object. (Inherited from OdDbObject) | |
Retrieves the shadow parameters of this light. | |
Called as the first operation as this object is being closed, for database -resident objects only. (Inherited from OdDbObject) | |
Called as the first operation as this object is being erased or unerased. (Inherited from OdDbEntity) | |
Called as the first operation when this object is being erased or unerased. | |
Called as the first operation as this object is being erased or unerased. (Inherited from OdDbObject) | |
overridables (Inherited from OdDbEntity) | |
overridables | |
Called as the first operation of the handOverTo function. (Inherited from OdDbEntity) | |
Called as the first operation of the handOverTo function. (Inherited from OdDbObject) | |
Highlights this object. | |
(Inherited from OdDbEntity) | |
Notification function called whenever a method of the specified subobject has called assertWriteEnabled() (Inherited from OdDbObject) | |
Notification function called by the Drawings framework immediately before an object is opened. (Inherited from OdDbEntity) | |
Notification function called by the Drawings framework immediately before an object is opened. (Inherited from OdDbObject) | |
Sets the values of this object's subentity traits, and returns with the calling object's subentity traits. (Inherited from OdDbEntity) | |
Sets the vectorization attributes of this object, and returns its attribute flags. | |
Sets the values of this object's subentity traits, and returns with the calling object's subentity traits. (Inherited from OdDbObject) | |
Called by setDatabaseDefaults() after the values are set. (Inherited from OdDbEntity) | |
This function is called as the first operation of the swapIdWith() function. (Inherited from OdDbEntity) | |
Called as the first operation of swapIdWith (Inherited from OdDbObject) | |
Applies the specified 3D transformation matrix to this entity. | |
(Inherited from OdDbEntity) | |
Creates a viewport-dependent geometric representation of this object. | |
(Inherited from OdDbObject) | |
(Inherited from OdDbEntity) | |
Creates a viewport-independent geometric representation of this object. | |
(Inherited from OdDbObject) | |
(Inherited from OdDbEntity) | |
(Inherited from OdDbEntity) | |
Swaps the objectIDs, handles, XData,and extension dictionary between this object and another object. (Inherited from OdDbObject) | |
Retrieves the target location of a light. | |
Returns the temporary (not saved) visibility status of this entity. (Inherited from OdDbEntity) | |
Applies the specified 3D transformation matrix to this entity. (Inherited from OdDbEntity) | |
(Inherited from OdDbEntity) | |
Returns the transparency setting of this entity. (Inherited from OdDbEntity) | |
Notification function called whenever the Undo process processes the appending of the notifying object to the database. (Inherited from OdDbObject) | |
Returns the undo filer associated with this object. (Inherited from OdDbObject) | |
Upgrades this object from OdDb::kForRead to OdDb::kForWrite. (Inherited from OdDbObject) | |
Returns the visibility status of this entity. It takes into account both permanent (DXF 60) and temporary visibility statuses: the entity is visible only if it's visible in both parts. (Inherited from OdDbEntity) | |
Returns the Object ID of the *visual style* used by this entity. (Inherited from OdDbEntity) | |
Performs a shallow clone of this object. (Inherited from OdDbObject) | |
Retrieves the full path to the file that stores the light's goniometric data (.ies file). | |
Retrieves the rotation offset used to orient the goniometric data relative to the light orientation. | |
Returns a linked list of ResBufs containing a copy of the XData of this object. (Inherited from OdDbObject) | |
Applies the 3D transformation matrix to the XData of this object. (Inherited from OdDbObject) | |
Allows a subobject of a complex object to notify its root object that it has been changed. (Inherited from OdDbObject) |
Copyright © 2002-2022. Open Design Alliance All rights reserved.
|