CFx SDK Documentation 2024 SP0
Loading...
Searching...
No Matches
Public Member Functions | Static Public Member Functions | Protected Types | Protected Member Functions | Protected Attributes | List of all members
OdGsLightNode Class Reference

#include <GsLightNode.h>

Inheritance diagram for OdGsLightNode:
OdGsEntityNode OdGsNode OdSiEntity OdGsCache OdRxObject

Public Member Functions

 ODRX_DECLARE_MEMBERS (OdGsLightNode)
 
 ~OdGsLightNode ()
 
 OdGsLightNode (OdGsBaseModel *pModel, const OdGiDrawable *pUnderlyingDrawable, bool bSetGsNode=true)
 
void setModelTransform (const OdGeMatrix3d &xform)
 
OdGeMatrix3d modelTransform () const
 
void setLightOwner (OdGsUpdateContext &ctx, OdGsContainerNode *pParent)
 
bool isOwnedBy (OdGsUpdateContext &ctx, OdGsContainerNode *pParent) const
 
bool isOwnedBy (const OdGsNode *pOwner) const
 
OdGsNodegetLightOwner () const
 
OdGiLightTraitsData::LightType lightType ()
 
virtual bool isLight () const
 
OdGiPointLightTraitsDatapointLightTraitsData (OdUInt32 viewportID=(OdUInt32) ULONG_MAX)
 
OdGiSpotLightTraitsDataspotLightTraitsData (OdUInt32 viewportID=(OdUInt32) ULONG_MAX)
 
OdGiDistantLightTraitsDatadistantLightTraitsData (OdUInt32 viewportID=(OdUInt32) ULONG_MAX)
 
OdGiWebLightTraitsDatawebLightTraitsData (OdUInt32 viewportID=(OdUInt32) ULONG_MAX)
 
OdGiLightTraitsDatalightTraitsData (OdUInt32 viewportID=(OdUInt32) ULONG_MAX)
 
virtual void invalidate (OdGsContainerNode *pParent, OdGsViewImpl *pView, OdUInt32 mask)
 
virtual void update (OdGsUpdateContext &ctx, OdGsContainerNode *pParent, OdSiSpatialIndex *)
 
virtual bool saveClientNodeState (OdGsFiler *pFiler, OdGsBaseVectorizer *pVectorizer) const
 
virtual bool loadClientNodeState (OdGsFiler *pFiler, OdGsBaseVectorizer *pVectorizer)
 
void updateViewportDependent (OdGsViewImpl *pView)
 
- Public Member Functions inherited from OdGsEntityNode
OdGsEntityNode::MetafilePtr metafileAt (int metafileIndex) const
 
void setMetafile (OdGsEntityNode::Metafile *metafiles)
 
void setMetafileAt (int metafileIndex, OdGsEntityNode::Metafile *pMetafile)
 
void convertToViewportDependent (const OdGsUpdateContext &ctx)
 
OdGsEntityNode::Metafilemetafile (const OdGsViewImpl &view, OdGsUpdateContext *ctx, MetafileCompatibilityLevel findCompatibleLevel=kFindCompatible)
 
void setMetafile (OdGsUpdateContext &ctx, OdGsEntityNode::Metafile *metafiles)
 
OdRxObjectfindCompatibleCache (const OdGsViewImpl &keyView, OdGsUpdateContext *ctx, OdUInt32 awareMask=0)
 
 ODRX_DECLARE_MEMBERS (OdGsEntityNode)
 
 OdGsEntityNode (OdGsBaseModel *pModel, const OdGiDrawable *pUnderlyingDrawable, bool bSetGsNode=false)
 
 ~OdGsEntityNode ()
 
void setNextEntity (OdGsEntityNode *pNextEntity)
 
void setNextEntity (OdUInt32 nVpId, OdGsEntityNode *pNextEntity)
 
OdGsEntityNodenextEntity ()
 
OdGsEntityNodenextEntity (OdUInt32 nVpId)
 
const OdGsEntityNodenextEntity () const
 
const OdGsEntityNodenextEntity (OdUInt32 nVpId) const
 
OdUInt32 numNextEntity () const
 
void enableMultipleNextEntities (OdUInt32 nMaxVpId)
 
void update (OdGsUpdateContext &ctx, OdGsContainerNode *pParent, OdSiSpatialIndex *pParentIndex)
 
void updateVisible (OdGsViewImpl *pViewImpl)
 
virtual OdGsEntityNode::MetafilePtr regenMetafile (OdGsUpdateContext &ctx, OdUInt32 vpDepFlags)
 
virtual OdUInt32 awareFlags (OdUInt32 viewportId) const
 
virtual ENodeType nodeType () const
 
virtual bool isReference () const
 
virtual bool isLight () const
 
virtual bool isSelfReferential () const
 
void display (OdGsDisplayContext &ctx)
 
void select (OdGsBaseVectorizer &view)
 
void invalidate (OdGsContainerNode *pParent, OdGsViewImpl *pView, OdUInt32 mask)
 
bool extents (OdGeExtents3d &extents) const
 
bool spatiallyIndexed () const
 
bool spatiallyIndexed (OdUInt32 nVpId) const
 
void setSpatiallyIndexed (bool spatiallyIndexed)
 
void setSpatiallyIndexed (OdUInt32 nVpId, bool spatiallyIndexed)
 
bool owned () const
 
bool owned (OdUInt32 nVpId) const
 
void setOwned (bool owned)
 
void setOwned (OdUInt32 nVpId, bool owned)
 
bool markedByUpdateManager () const
 
void setMarkedByUpdateManager (bool marked)
 
bool hasExtents () const
 
const OdGeExtents3dextents () const
 
virtual bool isEmpty ()
 
virtual bool hasFrozenLayers ()
 
bool markedToSkip (unsigned mask)
 
void markToSkip (unsigned mask, bool markToSkip)
 
void markToSkipAll ()
 
void destroy ()
 
virtual bool layersChanged (OdGsViewImpl &view) const
 
bool markedAsNonSelectable () const
 
void markAsNonSelectable (bool val)
 
bool isMarkedSkipSelection () const
 
void markSkipSelection (bool val)
 
bool isMarkedErased () const
 
void markErased (bool val)
 
bool isInWorkset () const
 
void setInWorkset (bool val)
 
bool isRegenOnDraw () const
 
void setRegenOnDraw (bool val)
 
bool isSingleThreaded () const
 
void setSingleThreaded (bool val)
 
bool skipDisplayClipping () const
 
void setSkipDisplayClipping (bool bOn)
 
bool isXref () const
 
virtual void highlight (bool bDoIt, bool bWholeBranch, OdUInt32 nSelStyle=0)
 
void setHlBranch (OdGsStateBranch *pBr)
 
OdGsStateBranchhlBranch ()
 
const OdGsStateBranchhlBranch () const
 
void hide (bool bDoIt, bool bSelectable=false, bool bWholeBranch=true)
 
void setVisibilityBranch (OdGsStateBranch *pBr)
 
OdGsStateBranchvisibilityBranch ()
 
const OdGsStateBranchvisibilityBranch () const
 
virtual void playAsGeometry (OdGsBaseVectorizer &view, EMetafilePlayMode eMode)
 
bool extents (const OdGsView *pView, OdGeExtents3d &ext) const
 
OdDb::LineWeight getMaxLineweightUsed () const
 
void addMaxLineweightUsed (OdDb::LineWeight lwd)
 
void setMaxLineweightUsed (OdDb::LineWeight lwd)
 
bool entityUnerased () const
 
void setEntityUnerased (bool flag)
 
bool isInvisible () const
 
bool isExtentsOutOfModelSpace () const
 
void setExtentsOutOfModelSpace (bool flag)
 
void resetInvalidVpFlag ()
 
void setAsLightSourceOwner (bool bSet)
 
bool isLightSourceOwner () const
 
bool isRequireRegenOnHighlightChange () const
 
virtual void makeStock ()
 
virtual void releaseStock ()
 
virtual void propagateLayerChangesStock ()
 
bool saveNodeState (OdGsFiler *pFiler, OdGsBaseVectorizer *pVectorizer=NULL) const
 
bool loadNodeState (OdGsFiler *pFiler, OdGsBaseVectorizer *pVectorizer=NULL)
 
void addContentToUpdateManager (OdUInt32 viewportId, OdGsUpdateManager *pManager, const UpdateManagerContext &context)
 
bool isMetafilesCompatible (const OdGsViewImpl *pView1, const OdGsViewImpl *pView2, OdGsUpdateContext *ctx)
 
- Public Member Functions inherited from OdGsNode
bool invalidVp () const
 
void setToDrawable (const OdGiDrawable *pUnderlyingDrawable)
 
 ODRX_DECLARE_MEMBERS (OdGsNode)
 
voidoperator new (size_t)
 
void operator delete (void *)
 
void addRef ()
 
void release ()
 
 OdGsNode (OdGsBaseModel *pModel, const OdGiDrawable *pUnderlyingDrawable)
 
virtual ~OdGsNode ()
 
OdGsBaseModelbaseModel () const
 
OdGsModelmodel () const
 
bool isContainer () const
 
virtual ENodeType nodeType () const =0
 
bool isSyncDrawable () const
 
virtual void invalidate (OdGsContainerNode *pParent, OdGsViewImpl *pView, OdUInt32 mask)=0
 
OdGiDrawablePtr underlyingDrawable () const
 
OdDbStub * underlyingDrawableId () const
 
virtual void update (OdGsUpdateContext &ctx, OdGsContainerNode *pParent, OdSiSpatialIndex *pParentIndex)=0
 
virtual void updateVisible (OdGsViewImpl *pViewImpl)
 
virtual void display (OdGsDisplayContext &ctx)=0
 
virtual void propagateLayerChanges (OdGsViewImpl &view)=0
 
virtual void highlight (bool bDoIt, bool bWholeBranch, OdUInt32 nSelStyle=0)
 
bool isHighlighted () const
 
bool isHighlightedAll () const
 
virtual void destroy ()=0
 
virtual void hide (bool bDoIt, bool bSelectable=false, bool bWholeBranch=true)
 
bool isHidden () const
 
bool isSelectableIfHidden () const
 
bool isHiddenAll () const
 
OdUInt32 selectionStyle () const
 
bool hasSelectionStyle () const
 
OdUInt32 userFlags () const
 
void setUserFlags (OdUInt32 val)
 
virtual bool saveNodeState (OdGsFiler *pFiler, OdGsBaseVectorizer *pVectorizer=NULL) const
 
virtual bool loadNodeState (OdGsFiler *pFiler, OdGsBaseVectorizer *pVectorizer=NULL)
 
virtual bool saveClientNodeState (OdGsFiler *pFiler, OdGsBaseVectorizer *pVectorizer) const
 
virtual bool loadClientNodeState (OdGsFiler *pFiler, OdGsBaseVectorizer *pVectorizer)
 
virtual bool postprocessNodeLoading (OdGsFiler *pFiler)
 
 TD_USING (OdGsCache::extents)
 
virtual bool extents (const OdGsView *pView, OdGeExtents3d &ext) const
 
bool modelExtents (OdGeExtents3d &ext, bool bUseModelTf=true) const
 
bool modelExtents (const OdGsView *pView, OdGeExtents3d &ext, bool bUseModelTf=true) const
 
virtual OdDb::LineWeight getMaxLineweightUsed () const
 
virtual void setDrawableNull ()
 
virtual void addContentToUpdateManager (OdUInt32 viewportId, OdGsUpdateManager *pManager, const UpdateManagerContext &context)
 
virtual bool isMetafilesCompatible (const OdGsViewImpl *pView1, const OdGsViewImpl *pView2, OdGsUpdateContext *ctx)
 
- Public Member Functions inherited from OdGsCache
 ODRX_DECLARE_MEMBERS (OdGsCache)
 
virtual OdGsModelmodel () const =0
 
virtual void setDrawableNull ()=0
 
virtual bool extents (OdGeExtents3d &extents) const =0
 
- Public Member Functions inherited from OdRxObject
 ODRX_HEAP_OPERATORS ()
 
 OdRxObject ()
 
virtual ~OdRxObject ()
 
virtual OdRxObjectqueryX (const OdRxClass *pClass) const
 
virtual OdRxObjectx (const OdRxClass *pClass) const
 
virtual OdRxClassisA () 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
 
virtual bool extents (OdGeExtents3d &extents) const =0
 

Static Public Member Functions

static bool drawableIsLight (const OdGiDrawable *pDrawable)
 
- Static Public Member Functions inherited from OdGsEntityNode
static voidAlloc (size_t nBytes)
 
static void Free (void *pMemBlock)
 
static voidRealloc (void *pMemBlock, size_t newSize, size_t)
 
static OdGsEntityNode::MetafilePtr getEmptyMetafile (OdUInt32 flags, OdGsLayerNode *pLayerNode=NULL)
 
static unsigned markToSkipMask (OdUInt32 threadIndex)
 
- Static Public Member Functions inherited from OdRxObject
static OdRxObjectPtr cast (const OdRxObject *pointer)
 
static OdRxClassdesc ()
 

Protected Types

enum  { kViewportDependentLight = (OdGsEntityNode::kLastFlag << 1) , kViewportDependentNeedUpdate = (OdGsEntityNode::kLastFlag << 2) , kLightDrawableIsInvisible = (OdGsEntityNode::kLastFlag << 3) , kLastFlag = kLightDrawableIsInvisible }
 
typedef OdVector< OdIntPtr, OdMemoryAllocator< OdIntPtr > > LightInsertPath
 
- Protected Types inherited from OdGsEntityNode
enum  {
  kHasExtents = OdGsNode::kLastFlag << 1 , kSpatiallyIndexed = OdGsNode::kLastFlag << 2 , kInWorkset = OdGsNode::kLastFlag << 3 , kSingleThreaded = OdGsNode::kLastFlag << 4 ,
  kOwned = OdGsNode::kLastFlag << 5 , kDrawableRegenDraw = OdGsNode::kLastFlag << 6 , kEntityUnerased = OdGsNode::kLastFlag << 7 , kInvisible = OdGsNode::kLastFlag << 8 ,
  kExtentsOutOfMS = OdGsNode::kLastFlag << 9 , kNonSelectable = OdGsNode::kLastFlag << 10 , kSkipSelection = OdGsNode::kLastFlag << 11 , kErased = OdGsNode::kLastFlag << 12 ,
  kDrawableIsXref = OdGsNode::kLastFlag << 13 , kMultilistNextPtr = OdGsNode::kLastFlag << 14 , kLastFlag = kMultilistNextPtr
}
 
enum  {
  kLineweightBit1 = (1 << 0) , kLineweightBit2 = (1 << 1) , kLineweightOffset = 0 , kLineweightBit3 = (1 << 2) ,
  kLineweightBit4 = (1 << 3) , kLineweightBit5 = (1 << 4) , kLineweightBit6 = (1 << 5) , kLineweightBit7 = (1 << 6) ,
  kLineweightBit8 = (1 << 7) , kLineweightBitMask = kLineweightBit1 | kLineweightBit2 | kLineweightBit3 | kLineweightBit4 | kLineweightBit5 | kLineweightBit6 | kLineweightBit7 | kLineweightBit8 , kLightSourceOwner = (1 << 8) , kRegenOnHighlight = (1 << 9) ,
  kMarkedByUpdateManager = (1 << 10) , kSkipDisplayClipping = (1 << 11) , kLastEntFlag = kSkipDisplayClipping
}
 
enum  { kMarkedToSkipFirst = 0x00000001 , kMarkedToSkipLast = kMarkedToSkipFirst << 30 , kMarkedToSkipAll = 0x7FFFFFFF }
 
- Protected Types inherited from OdGsNode
enum  {
  kPersistent = 0x00000001 , kContainer = 0x00000002 , kHLT = 0x00000004 , kHLT_All = 0x00000008 ,
  kSyncDrawable =0x00000010 , kHidden = 0x00000020 , kSelectHidden =0x00000040 , kHiddenAll = 0x00000080 ,
  kSelStyle = 0x00000100 , kLastFlag = kSelStyle
}
 
enum  { kInvalidateVp = 0x80000000 }
 

Protected Member Functions

void update ()
 
void contextualUpdate (OdGsUpdateContext &ctx)
 
void adjustViewportDependentLightTraitsData (OdGiLightTraitsVpDepData *vdData, OdGiLightTraitsData *data)
 
void clearVpDepTraitsMap ()
 
- Protected Member Functions inherited from OdGsEntityNode
virtual void propagateLayerChanges (OdGsViewImpl &view)
 
MetafilePtrArraymetafileArray ()
 
const MetafilePtrArraymetafileArray () const
 
OdGsEntityNode::MetafilePtr metafile () const
 
void setExtentsFromMetafiles ()
 
bool findMetafileInStock (OdGsUpdateContext &ctx)
 
void insertToSpatialIndex (OdUInt32 nVpId, OdSiSpatialIndex &parentIndex, const OdGeExtents3d &prevExtents)
 
void setExtentsFlags ()
 
- Protected Member Functions inherited from OdGsNode
void setInvalidVp (bool val)
 
void clearDrawable ()
 
void setSelectionStyleImpl (OdUInt32 nStyle)
 
OdUInt32 getSelectionStyleImpl () const
 
 OdGsNode (const OdGsNode &c)
 

Protected Attributes

OdGeMatrix3d m_model2World
 
OdGiLightTraitsDatam_pLightTraits
 
OdGsNodem_pLightParent
 
LightInsertPath m_lightInsertParents
 
std::map< OdUInt32, OdGiLightTraitsData * > m_mapVpDepTraitsData
 
- Protected Attributes inherited from OdGsEntityNode
OdGeExtents3d m_extents
 
OdGsStateBranchPtr m_hlBranch
 
OdGsStateBranchPtr m_visBranch
 
MetafileHolder m_metafile
 
OdUInt32 m_entFlags
 
- Protected Attributes inherited from OdGsNode
OdGsNodem_pPrev
 
OdGsNodem_pNext
 
OdGsBaseModelm_pModel
 
voidm_underlyingDrawable
 
OdUInt32 m_flags
 
OdUInt32 m_userFlags
 

Additional Inherited Members

- Public Types inherited from OdGsEntityNode
enum  MetafileCompatibilityLevel { kSkipCheckCompatible = 0 , kCheckViewChanges = 1 , kCheckCompatibleView = 2 , kFindCompatible = 3 }
 
typedef OdSmartPtr< MetafileMetafilePtr
 
- Static Protected Attributes inherited from OdGsNode
static GS_STATIC_EXPORT AllocatorArray s_aAlloc
 

Detailed Description

<group OdGs_Classes>

Definition at line 39 of file GsLightNode.h.

Member Typedef Documentation

◆ LightInsertPath

Definition at line 45 of file GsLightNode.h.

Member Enumeration Documentation

◆ anonymous enum

anonymous enum
protected
Enumerator
kViewportDependentLight 
kViewportDependentNeedUpdate 
kLightDrawableIsInvisible 
kLastFlag 

Definition at line 49 of file GsLightNode.h.

Constructor & Destructor Documentation

◆ ~OdGsLightNode()

OdGsLightNode::~OdGsLightNode ( )

Destructor for the OdGsLightNode class.

◆ OdGsLightNode()

OdGsLightNode::OdGsLightNode ( OdGsBaseModel pModel,
const OdGiDrawable pUnderlyingDrawable,
bool  bSetGsNode = true 
)

Constructor for the OdGsLightNode class.

Parameters
pModel[in] Pointer to the BaseModel object.
pUnderlyingDrawable[in] Pointer to the underlying Drawable object.
bSetGsNode[in] Flag that controls whether to set GS node to the underlying drawable.

Member Function Documentation

◆ adjustViewportDependentLightTraitsData()

void OdGsLightNode::adjustViewportDependentLightTraitsData ( OdGiLightTraitsVpDepData vdData,
OdGiLightTraitsData data 
)
inlineprotected

Definition at line 321 of file GsLightNode.h.

◆ clearVpDepTraitsMap()

void OdGsLightNode::clearVpDepTraitsMap ( )
inlineprotected

Definition at line 334 of file GsLightNode.h.

◆ contextualUpdate()

void OdGsLightNode::contextualUpdate ( OdGsUpdateContext &  ctx)
protected

◆ distantLightTraitsData()

OdGiDistantLightTraitsData * OdGsLightNode::distantLightTraitsData ( OdUInt32  viewportID = (OdUInt32)ULONG_MAX)
inline

Retrieves a pointer to the distant light traits data.

Parameters
viewportID[in] Viewport ID for viewport-dependent lights.
Returns
pointer to an object that stores distant light traits data, or NULL if type of this light node is not kDistantLight.

Definition at line 280 of file GsLightNode.h.

◆ drawableIsLight()

bool OdGsLightNode::drawableIsLight ( const OdGiDrawable pDrawable)
inlinestatic

Checks whether the passed drawable is light.

Parameters
pDrawable[in] Pointer to the Drawable object.
Returns
true if the specified drawable is a light entity, false otherwise.

Definition at line 329 of file GsLightNode.h.

◆ getLightOwner()

OdGsNode * OdGsLightNode::getLightOwner ( ) const
inline

Retrieves a pointer to the node that owns this light node.

Definition at line 125 of file GsLightNode.h.

◆ invalidate()

virtual void OdGsLightNode::invalidate ( OdGsContainerNode pParent,
OdGsViewImpl pView,
OdUInt32  mask 
)
virtual

Invalidates this object.

Parameters
pParent[in] Pointer to the ContainerNode object for this Node object.
pView[in] Pointer to the OdGsViewImpl object for which data are to be invalidated.
mask[in] Mask for viewport properties.

Reimplemented from OdGsEntityNode.

◆ isLight()

bool OdGsLightNode::isLight ( ) const
inlinevirtual

Checks whether this node is light node.

Returns
true.

Reimplemented from OdGsEntityNode.

Definition at line 247 of file GsLightNode.h.

◆ isOwnedBy() [1/2]

bool OdGsLightNode::isOwnedBy ( const OdGsNode pOwner) const
inline

Checks whether the passed container GS node is a parent of the light.

Parameters
pOwner[in] Node to check.
Returns
true if the passed GS node owns this light node, false otherwise.

Definition at line 120 of file GsLightNode.h.

◆ isOwnedBy() [2/2]

bool OdGsLightNode::isOwnedBy ( OdGsUpdateContext &  ctx,
OdGsContainerNode pParent 
) const

Checks whether the passed container node is a parent of the light.

Parameters
ctx[in] Update context.
pParent[in] Container node to check.
Returns
true if the passed container node owns this light node, false otherwise.

◆ lightTraitsData()

OdGiLightTraitsData * OdGsLightNode::lightTraitsData ( OdUInt32  viewportID = (OdUInt32)ULONG_MAX)
inline

Retrieves a pointer to the generic light traits data object.

Parameters
viewportID[in] Viewport ID for viewport-dependent lights.

Definition at line 308 of file GsLightNode.h.

◆ lightType()

OdGiLightTraitsData::LightType OdGsLightNode::lightType ( )
inline

Retrieves light type of this node.

Definition at line 242 of file GsLightNode.h.

◆ loadClientNodeState()

virtual bool OdGsLightNode::loadClientNodeState ( OdGsFiler pFiler,
OdGsBaseVectorizer pVectorizer 
)
virtual

Loads data of a client light node from the specified filer.

Parameters
pFiler[in] Pointer to a filer where to save node state.
pVectorizer[in] Pointer to the vectorizer.
Returns
true if the state of the client light node is loaded successfully, false otherwise.

Reimplemented from OdGsNode.

◆ modelTransform()

OdGeMatrix3d OdGsLightNode::modelTransform ( ) const
inline

Retrieves modeling transformation matrix.

Definition at line 93 of file GsLightNode.h.

◆ ODRX_DECLARE_MEMBERS()

OdGsLightNode::ODRX_DECLARE_MEMBERS ( OdGsLightNode  )

◆ pointLightTraitsData()

OdGiPointLightTraitsData * OdGsLightNode::pointLightTraitsData ( OdUInt32  viewportID = (OdUInt32)ULONG_MAX)
inline

Retrieves a pointer to the point light traits data.

Parameters
viewportID[in] Viewport ID for viewport-dependent lights.
Returns
pointer to an object that stores point light traits data, or NULL if type of this light node is not kPointLight and kWebLight.

Definition at line 252 of file GsLightNode.h.

◆ saveClientNodeState()

virtual bool OdGsLightNode::saveClientNodeState ( OdGsFiler pFiler,
OdGsBaseVectorizer pVectorizer 
) const
virtual

Saves data of a client light node to the specified filer.

Parameters
pFiler[out] Pointer to a filer where to save node state.
pVectorizer[in] Pointer to the vectorizer.
Returns
true if the state of the client light node is saved successfully, false otherwise.

Reimplemented from OdGsNode.

◆ setLightOwner()

void OdGsLightNode::setLightOwner ( OdGsUpdateContext &  ctx,
OdGsContainerNode pParent 
)

Sets a parent object for the light.

Parameters
ctx[in] Update context.
pParent[in] Parent container node of the light.

◆ setModelTransform()

void OdGsLightNode::setModelTransform ( const OdGeMatrix3d xform)
inline

Sets modeling transformation matrix.

Parameters
xform[in] Modeling transformation matrix.

Definition at line 88 of file GsLightNode.h.

◆ spotLightTraitsData()

OdGiSpotLightTraitsData * OdGsLightNode::spotLightTraitsData ( OdUInt32  viewportID = (OdUInt32)ULONG_MAX)
inline

Retrieves a pointer to the spot light traits data.

Parameters
viewportID[in] Viewport ID for viewport-dependent lights.
Returns
pointer to an object that stores spot light traits data, or NULL if type of this light node is not kSpotLight.

Definition at line 266 of file GsLightNode.h.

◆ update() [1/2]

void OdGsLightNode::update ( )
protected

◆ update() [2/2]

virtual void OdGsLightNode::update ( OdGsUpdateContext &  ctx,
OdGsContainerNode pParent,
OdSiSpatialIndex  
)
virtual

Updates this light node.

Parameters
ctx[in] Current update context.
pParent[in] Parent container node.
parentIndex[in] Parent spatial index.

Reimplemented from OdGsEntityNode.

◆ updateViewportDependent()

void OdGsLightNode::updateViewportDependent ( OdGsViewImpl pView)

Updates viewport-dependent properties.

Parameters
pView[in] View implementation.

◆ webLightTraitsData()

OdGiWebLightTraitsData * OdGsLightNode::webLightTraitsData ( OdUInt32  viewportID = (OdUInt32)ULONG_MAX)
inline

Retrieves a pointer to the web light traits data.

Parameters
viewportID[in] Viewport ID for viewport-dependent lights.
Returns
pointer to an object that stores web light traits data, or NULL if type of this light node is not kWebLight.

Definition at line 294 of file GsLightNode.h.

Member Data Documentation

◆ m_lightInsertParents

LightInsertPath OdGsLightNode::m_lightInsertParents
protected

Definition at line 46 of file GsLightNode.h.

◆ m_mapVpDepTraitsData

std::map< OdUInt32, OdGiLightTraitsData* > OdGsLightNode::m_mapVpDepTraitsData
protected

Definition at line 47 of file GsLightNode.h.

◆ m_model2World

OdGeMatrix3d OdGsLightNode::m_model2World
protected

Definition at line 42 of file GsLightNode.h.

◆ m_pLightParent

OdGsNode* OdGsLightNode::m_pLightParent
protected

Definition at line 44 of file GsLightNode.h.

◆ m_pLightTraits

OdGiLightTraitsData* OdGsLightNode::m_pLightTraits
protected

Definition at line 43 of file GsLightNode.h.


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