UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
IDatasmithLightActorElement Class Referenceabstract

#include <IDatasmithSceneElements.h>

+ Inheritance diagram for IDatasmithLightActorElement:

Public Member Functions

virtual ~IDatasmithLightActorElement ()
 
virtual bool IsEnabled () const =0
 
virtual void SetEnabled (bool bIsEnabled)=0
 
virtual double GetIntensity () const =0
 
virtual void SetIntensity (double Intensity)=0
 
virtual FLinearColor GetColor () const =0
 
virtual void SetColor (FLinearColor Color)=0
 
virtual double GetTemperature () const =0
 
virtual void SetTemperature (double Temperature)=0
 
virtual bool GetUseTemperature () const =0
 
virtual void SetUseTemperature (bool bUseTemperature)=0
 
virtual const TCHARGetIesFile () const =0
 
virtual const TCHARGetIesTexturePathName () const =0
 
virtual void SetIesFile (const TCHAR *IesFile)=0
 
virtual void SetIesTexturePathName (const TCHAR *TextureName)=0
 
virtual bool GetUseIes () const =0
 
virtual void SetUseIes (bool bUseIes)=0
 
virtual double GetIesBrightnessScale () const =0
 
virtual void SetIesBrightnessScale (double IesBrightnessScale)=0
 
virtual bool GetUseIesBrightness () const =0
 
virtual void SetUseIesBrightness (bool bUseIesBrightness)=0
 
virtual FQuat GetIesRotation () const =0
 
virtual void SetIesRotation (const FQuat &IesRotation)=0
 
virtual TSharedPtr< IDatasmithMaterialIDElement > & GetLightFunctionMaterial ()=0
 
virtual void SetLightFunctionMaterial (const TSharedPtr< IDatasmithMaterialIDElement > &InMaterial)=0
 
virtual void SetLightFunctionMaterial (const TCHAR *InMaterialName)=0
 
- Public Member Functions inherited from IDatasmithActorElement
virtual ~IDatasmithActorElement ()
 
virtual FVector GetTranslation () const =0
 
virtual void SetTranslation (double InX, double InY, double InZ, bool bKeepChildrenRelative=true)=0
 
virtual void SetTranslation (const FVector &Value, bool bKeepChildrenRelative=true)=0
 
virtual FVector GetScale () const =0
 
virtual void SetScale (double InX, double InY, double InZ, bool bKeepChildrenRelative=true)=0
 
virtual void SetScale (const FVector &Value, bool bKeepChildrenRelative=true)=0
 
virtual FQuat GetRotation () const =0
 
virtual void SetRotation (double InX, double InY, double InZ, double InW, bool bKeepChildrenRelative=true)=0
 
virtual void SetRotation (const FQuat &Value, bool bKeepChildrenRelative=true)=0
 
virtual FTransform GetRelativeTransform () const =0
 
virtual const TCHARGetLayer () const =0
 
virtual void SetLayer (const TCHAR *InLayer)=0
 
virtual void AddTag (const TCHAR *InTag)=0
 
virtual void ResetTags ()=0
 
virtual int32 GetTagsCount () const =0
 
virtual const TCHARGetTag (int32 TagIndex) const =0
 
virtual void AddChild (const TSharedPtr< IDatasmithActorElement > &InChild, EDatasmithActorAttachmentRule AttachementRule=EDatasmithActorAttachmentRule::KeepWorldTransform)=0
 
virtual int32 GetChildrenCount () const =0
 
virtual TSharedPtr< IDatasmithActorElementGetChild (int32 InIndex)=0
 
virtual const TSharedPtr< IDatasmithActorElement > & GetChild (int32 InIndex) const =0
 
virtual void RemoveChild (const TSharedPtr< IDatasmithActorElement > &InChild)=0
 
virtual const TSharedPtr< IDatasmithActorElement > & GetParentActor () const =0
 
virtual void SetIsAComponent (bool Value)=0
 
virtual bool IsAComponent () const =0
 
virtual void SetVisibility (bool bInVisibility)=0
 
virtual bool GetVisibility () const =0
 
virtual void SetCastShadow (bool bInCastShadow)=0
 
virtual bool GetCastShadow () const =0
 
virtual void SetMobility (EDatasmithActorMobilityType Mobility)=0
 
virtual EDatasmithActorMobilityType GetMobility () const =0
 
- Public Member Functions inherited from IDatasmithElement
virtual bool IsA (EDatasmithElementType Type) const =0
 
virtual const TCHARGetName () const =0
 
virtual void SetName (const TCHAR *InName)=0
 
virtual const TCHARGetLabel () const =0
 
virtual void SetLabel (const TCHAR *InLabel)=0
 
virtual FMD5Hash CalculateElementHash (bool bForce)=0
 

Constructor & Destructor Documentation

◆ ~IDatasmithLightActorElement()

virtual IDatasmithLightActorElement::~IDatasmithLightActorElement ( )
inlinevirtual

Member Function Documentation

◆ GetColor()

virtual FLinearColor IDatasmithLightActorElement::GetColor ( ) const
pure virtual

Get light color on linear mode

◆ GetIesBrightnessScale()

virtual double IDatasmithLightActorElement::GetIesBrightnessScale ( ) const
pure virtual

Get the Ies brightness multiplier

◆ GetIesFile()

virtual const TCHAR * IDatasmithLightActorElement::GetIesFile ( ) const
pure virtual

Get the path of the Ies definition file - DEPRECATED in 4.26: Replaced with GetIesTexturePathName

◆ GetIesRotation()

virtual FQuat IDatasmithLightActorElement::GetIesRotation ( ) const
pure virtual

Get the rotation applied to the IES shape

◆ GetIesTexturePathName()

virtual const TCHAR * IDatasmithLightActorElement::GetIesTexturePathName ( ) const
pure virtual

Get the IES texture path

◆ GetIntensity()

virtual double IDatasmithLightActorElement::GetIntensity ( ) const
pure virtual

Get light intensity

◆ GetLightFunctionMaterial()

virtual TSharedPtr< IDatasmithMaterialIDElement > & IDatasmithLightActorElement::GetLightFunctionMaterial ( )
pure virtual

Get emissive material on this light

◆ GetTemperature()

virtual double IDatasmithLightActorElement::GetTemperature ( ) const
pure virtual

Get the light temperature in Kelvin

◆ GetUseIes()

virtual bool IDatasmithLightActorElement::GetUseIes ( ) const
pure virtual

Set if this light is controlled by Ies definition file

◆ GetUseIesBrightness()

virtual bool IDatasmithLightActorElement::GetUseIesBrightness ( ) const
pure virtual

Get if the emissive amount of the ies is controlled by the brightness scale

◆ GetUseTemperature()

virtual bool IDatasmithLightActorElement::GetUseTemperature ( ) const
pure virtual

Get if the light color is controlled by temperature

◆ IsEnabled()

virtual bool IDatasmithLightActorElement::IsEnabled ( ) const
pure virtual

Return true on light enabled, false otherwise

◆ SetColor()

virtual void IDatasmithLightActorElement::SetColor ( FLinearColor  Color)
pure virtual

Set light color on linear mode

◆ SetEnabled()

virtual void IDatasmithLightActorElement::SetEnabled ( bool  bIsEnabled)
pure virtual

Set enable property of the light

◆ SetIesBrightnessScale()

virtual void IDatasmithLightActorElement::SetIesBrightnessScale ( double  IesBrightnessScale)
pure virtual

Set the Ies brightness multiplier

◆ SetIesFile()

virtual void IDatasmithLightActorElement::SetIesFile ( const TCHAR IesFile)
pure virtual

Set the path of the Ies definition file - DEPRECATED in 4.26: Replaced with SetIesTexturePathName

◆ SetIesRotation()

virtual void IDatasmithLightActorElement::SetIesRotation ( const FQuat IesRotation)
pure virtual

Set the rotation to apply to the IES shape

◆ SetIesTexturePathName()

virtual void IDatasmithLightActorElement::SetIesTexturePathName ( const TCHAR TextureName)
pure virtual

Set the IES texture path The path is either the name of an element attached to the scene or the path of a UE texture asset, i.e. /Game/.../TextureAssetName.TextureAssetName

◆ SetIntensity()

virtual void IDatasmithLightActorElement::SetIntensity ( double  Intensity)
pure virtual

Set light intensity

◆ SetLightFunctionMaterial() [1/2]

virtual void IDatasmithLightActorElement::SetLightFunctionMaterial ( const TCHAR InMaterialName)
pure virtual

Set emissive material on this light

◆ SetLightFunctionMaterial() [2/2]

virtual void IDatasmithLightActorElement::SetLightFunctionMaterial ( const TSharedPtr< IDatasmithMaterialIDElement > &  InMaterial)
pure virtual

Set emissive material on this light

◆ SetTemperature()

virtual void IDatasmithLightActorElement::SetTemperature ( double  Temperature)
pure virtual

Set the light temperature in Kelvin

◆ SetUseIes()

virtual void IDatasmithLightActorElement::SetUseIes ( bool  bUseIes)
pure virtual

Get if this light is controlled by Ies definition file

◆ SetUseIesBrightness()

virtual void IDatasmithLightActorElement::SetUseIesBrightness ( bool  bUseIesBrightness)
pure virtual

Set if the emissive amount of the ies is controlled by the brightness scale

◆ SetUseTemperature()

virtual void IDatasmithLightActorElement::SetUseTemperature ( bool  bUseTemperature)
pure virtual

Set if the light color is controlled by temperature


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