pCon.planner Plugin SDK  Version 8.9
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Properties Events
Classes | Public Member Functions | Static Public Member Functions | Properties | List of all members
X3g::Plugin::DbLight Class Reference

A light source which is part of the document. More...

Inheritance diagram for X3g::Plugin::DbLight:
Inheritance graph
[legend]

Classes

class  Instance
 DbLights may be owned by blocks which are referenced multiple times. More...
 

Public Member Functions

bool GetLightEnabled (RenderingCategory pRenderingCategory)
 Returns if light is enabled for given rendering category. More...
 
void SetLightEnabled (RenderingCategory pRenderingCategory, bool pEnabled)
 Enables light for given rendering category. More...
 
bool GetGeometryEnabled (RenderingCategory pRenderingCategory)
 Returns if light geometry is enabled for given rendering category. More...
 
void SetGeometryEnabled (RenderingCategory pRenderingCategory, bool pEnabled)
 Enables light geometry for given rendering category. More...
 
bool GetShadowEnabled (RenderingCategory pRenderingCategory)
 Returns if shadow casting is enabled for given rendering category. More...
 
void SetShadowEnabled (RenderingCategory pRenderingCategory, bool pEnabled)
 Enables shadow casting for given rendering category. More...
 
bool GetPhotometricData (System::IO::Stream^ pStream,[Out] PhotometricDataFormat% pFormat)
 Allows to obtain photometric data. More...
 
void SetPhotometricData (System::IO::Stream^ pStream, PhotometricDataFormat pFormat)
 Sets photometric data in given format. More...
 
array< float >^ GetIntensityDistribution ([Out] int% pWidth,[Out] int% pHeight)
 Returns intensity distribution of photometric lights. More...
 
void UpdateLight ()
 After changes are made to the light this function should be called to update the realtime visualization. More...
 
- Public Member Functions inherited from X3g::Plugin::DbEntity
GeMatrixGetTextureMatrix ()
 The texture matrix determines how to map the material texture to the entity. More...
 
void SetTextureMatrix (GeMatrix^ pMatrix)
 Sets the texture matrix. More...
 
bool TransformBy (GeMatrix^ pTransform)
 Transforms the entity. More...
 
GeMatrixGetTransientTransform ()
 Returns transient transformation of this entity. More...
 
void SetTransientTransform (GeMatrix^ pTransform)
 Sets the transient transformation of this entity. More...
 
void UpdateGeometry ()
 Updates the geometry of the entity. More...
 
void Delete ()
 Deletes the entity from the document. More...
 
GeBoundingBox3dGetBoundingBox (GeMatrix^ pTransform)
 Returns bounding box of entity within the owning blocks local coordinate system. More...
 
IPropertyProvider^ GetPropertyProvider ()
 Returns property provider of the entity. More...
 
DbEntityClone (Block^ pOwner)
 Creates a clone of the entity. More...
 
DbEntityCut2 (DbEntity^ pEntity)
 Subtracts pEntity from this object. More...
 
DbEntityCut2 (DbEntity^ pEntity, Block^ pToOwner)
 Subtracts pEntity from this object. More...
 
DbEntityCommon2 (DbEntity^ pEntity)
 Computes an object which represents all common geometry of this entity and pEntity. More...
 
DbEntityCommon2 (DbEntity^ pEntity, Block^ pToOwner)
 Computes an object which represents all common geometry of this entity and pEntity. More...
 
DbEntityFuse2 (DbEntity^ pEntity)
 Computes an object by merging all geometry of this entity and pEntity. More...
 
DbEntityFuse2 (DbEntity^ pEntity, Block^ pToOwner)
 Computes an object by merging all geometry of this entity and pEntity. More...
 
List< DbEntity^ >^ Slice (GePlane^ pPlane, bool pKeepBothHalves)
 Slice the DbEntity with the plane. More...
 
DbEntityPartialMove (GePlane^ pPlane, double pLength)
 Strech or shrink the DbEntity at the given plane. More...
 
void AddCallbacks (DbEntityCallbacks^ pCallbacks)
 Add callbacks to the entity. More...
 
void RemoveCallbacks (DbEntityCallbacks^ pCallbacks)
 Remove callbacks from entity. More...
 

Static Public Member Functions

static IList< Instance^ >^ GetAllActiveInstances (RenderingCategory pRenderingCategory)
 Returns all active light instances in current document for given rendering category. More...
 
- Static Public Member Functions inherited from X3g::Plugin::DbEntity
static DbEntityFromId (String^ pEntityId)
 Creates DbEntity to given entity id. More...
 

Properties

X3g::Plugin::LightType LightType [get, set]
 The type of the light source. More...
 
System::Drawing::Color LightColor [get, set]
 The color of the light. More...
 
double Intensity [get, set]
 The intensity of the light in candela. More...
 
double OpeningAngle [get, set]
 The opening angle of a spot light in degrees; More...
 
double HotspotAngle [get, set]
 The hotspot angle of a spot light in degrees; More...
 
GeVec3d Position [get, set]
 The position of the light. More...
 
GeVec3d Target [get, set]
 The target of the light. More...
 
GeVec3d Up [get, set]
 Up vector of rectangular area light. More...
 
GeVec3d Size [get, set]
 The size of the light. More...
 
- Properties inherited from X3g::Plugin::DbEntity
String^  Id [get]
 The unqiue id of the entity. More...
 
String^  Name [get, set]
 User-defined name of the entity. More...
 
String^  Material [get, set]
 Material of this entity. More...
 
EntityColor Color [get, set]
 Color of this entity. More...
 
String^  Layer [get, set]
 Layer name of this entity. More...
 
String^  OwningBlock [get]
 Name of the block that owns this entity. More...
 
bool TopLevel [get]
 Returns if entity is owned by modelspace. More...
 
bool Valid [get]
 Returns if entity is valid and not erased. More...
 
DbTextureProjection TextureProjection [get, set]
 The AutoCAD texture projection. More...
 
bool IsModelingSupported [get]
 If true the entity can be used with modeling functions. More...
 
bool Locked [get, set]
 Lock status of this entity. More...
 
GeVec2d LayoutPosition [get, set]
 Position the Entity in Layout. More...
 
DbDictionary^  CustomData [get]
 Allows to attach custom data to the entity. More...
 
String^  CustomType [get, set]
 Allows plugins to identify their entities. More...
 
Object^  CustomObject
 Allows to attach an object which extents the entity (e.g. More...
 
bool IsVisible [get, set]
 Visibility of this entity. More...
 
Hyperlink Link [get, set]
 Get or Set the Hyperlink attached to the DbEntity. More...
 

Additional Inherited Members

- Package Functions inherited from X3g::Plugin::DbEntity
 DbEntity (Block^ pOwner, EntityImpl *pImpl)
 This constructor is used to create new OdDbEntities and add to a block. More...
 
 DbEntity (Layout::Page^ pPage, EntityImpl *pImpl)
 This constructor is used to create new OdDbEntities and add to a page. More...
 
- Events inherited from X3g::Plugin::DbEntity
System::EventHandler^  VisibilityChanged
 Occurs when DbEntity::IsVisible changed. More...
 

Detailed Description

A light source which is part of the document.

Member Function Documentation

IList< DbLight::Instance^ > X3g::Plugin::DbLight::GetAllActiveInstances ( RenderingCategory  pRenderingCategory)
static

Returns all active light instances in current document for given rendering category.

See Also
DbLight::Instance
bool X3g::Plugin::DbLight::GetGeometryEnabled ( RenderingCategory  pRenderingCategory)

Returns if light geometry is enabled for given rendering category.

array< float > X3g::Plugin::DbLight::GetIntensityDistribution ( [Out] int%  pWidth,
[Out] int%  pHeight 
)

Returns intensity distribution of photometric lights.

Returns null if data is not available.

bool X3g::Plugin::DbLight::GetLightEnabled ( RenderingCategory  pRenderingCategory)

Returns if light is enabled for given rendering category.

bool X3g::Plugin::DbLight::GetPhotometricData ( System::IO::Stream^  pStream,
[Out] PhotometricDataFormat pFormat 
)

Allows to obtain photometric data.

Returns
True if photometric data is available.
bool X3g::Plugin::DbLight::GetShadowEnabled ( RenderingCategory  pRenderingCategory)

Returns if shadow casting is enabled for given rendering category.

void X3g::Plugin::DbLight::SetGeometryEnabled ( RenderingCategory  pRenderingCategory,
bool  pEnabled 
)

Enables light geometry for given rendering category.

void X3g::Plugin::DbLight::SetLightEnabled ( RenderingCategory  pRenderingCategory,
bool  pEnabled 
)

Enables light for given rendering category.

void X3g::Plugin::DbLight::SetPhotometricData ( System::IO::Stream^  pStream,
PhotometricDataFormat  pFormat 
)

Sets photometric data in given format.

void X3g::Plugin::DbLight::SetShadowEnabled ( RenderingCategory  pRenderingCategory,
bool  pEnabled 
)

Enables shadow casting for given rendering category.

void X3g::Plugin::DbLight::UpdateLight ( )

After changes are made to the light this function should be called to update the realtime visualization.

Property Documentation

double X3g::Plugin::DbLight::HotspotAngle
getset

The hotspot angle of a spot light in degrees;

double X3g::Plugin::DbLight::Intensity
getset

The intensity of the light in candela.

System:: Drawing:: Color X3g::Plugin::DbLight::LightColor
getset

The color of the light.

X3g:: Plugin:: LightType X3g::Plugin::DbLight::LightType
getset

The type of the light source.

double X3g::Plugin::DbLight::OpeningAngle
getset

The opening angle of a spot light in degrees;

GeVec3d X3g::Plugin::DbLight::Position
getset

The position of the light.

No effect for directional lights.

GeVec3d X3g::Plugin::DbLight::Size
getset

The size of the light.

The bigger the light the softer the shadow. For lights other then area lights the size is equal in all dimensions. Returns angular size in case of directional light.

GeVec3d X3g::Plugin::DbLight::Target
getset

The target of the light.

GeVec3d X3g::Plugin::DbLight::Up
getset

Up vector of rectangular area light.

Vector has unit length and is perpendicular to light direction.