Share

LightingStyle Object


Description

The LightingStyle object provides access to all of the properties that define a specific lighting style.

Methods

Name Description
ConvertToLocal Method that creates a local cached copy of a global style and returns the local style. This method fails if this style is already local. Use the StyleLocation property to determine whether the style is local.
Copy Method that copies the rendering style and assigns the specified name to the copy. The new style is returned by the method.
Delete Method that deletes the LightingStyle.
GetReferenceKey Method that generates and returns the reference key for this entity.
SaveToGlobal Method that saves this style to the global repository. If a style with the same name is found in the repository, that style is updated.
UpdateFromGlobal Method that updates this style from the global repository.
UploadImage Upload an IBL image to current lighting style.

Properties

Name Description
Ambience Gets and sets the ambience of the lighting style.
AmbientShadowIntensity Gets and sets the intensity of the ambient shadow (occlusion).
Application Returns the top-level parent application object. When used the context of Inventor, an Application object is returned. When used in the context of Apprentice, an ApprenticeServer object is returned.
AttributeSets Property that returns the AttributeSets collection object associated with this object.
Brightness Gets and sets the brightness of the lighting style.
Exposure Gets and sets the exposure of the lighting style.
ImageBasedLightingBrightness Gets and sets the brightness of the lighting style.
ImageBasedLightingRotation Gets and sets the rotation to be applied to the image.
ImageBasedLightingScale Gets and sets the scale to be applied to the image.
ImageBasedLightingShowImage Gets and sets whether to display the image in the graphics scene.
InternalName property that returns the unique name of the style. The name is the internal English name of the style. This name will remain constant and is not affected by locale. This name is never displayed to the user.
InUse Property that indicates if this style is in use.
LightingStyleType Gets the lighting style type.
Lights Property that returns the Lights collection object.
Name Gets and sets the lighting style name.
Parent Property returning the parent of the object.
ShadowDensity Gets and sets the direction of the light source that controls the shadow.
ShadowDirection Gets and sets the direction of the light source that controls the shadow.
ShadowSoftness Gets and sets the blending between shadowed and non-shadowed areas.
StyleLocation Property that returns the location of this lighting style, i.e. local to the document, cached locally in the document, exists in the library. Lighting styles that exist in the library cannot be edited.
Type Returns an ObjectTypeEnum indicating this object's type.
UpToDate Property that gets the up-to-date status of the style against the global repository.

Accessed From

AssemblyDocument.ActiveLightingStyle, Light.Parent, LightingStyle.ConvertToLocal, LightingStyle.Copy, LightingStyles.Add, LightingStyles.Item, PartDocument.ActiveLightingStyle, PresentationDocument.ActiveLightingStyle

Version

Introduced in version 10

Was this information helpful?