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

#include <IDatasmithSceneElements.h>

+ Inheritance diagram for IDatasmithAreaLightElement:

Public Member Functions

virtual EDatasmithLightShape GetLightShape () const =0
 
virtual void SetLightShape (EDatasmithLightShape Shape)=0
 
virtual void SetLightType (EDatasmithAreaLightType LightType)=0
 
virtual EDatasmithAreaLightType GetLightType () const =0
 
virtual void SetWidth (float InWidth)=0
 
virtual float GetWidth () const =0
 
virtual void SetLength (float InLength)=0
 
virtual float GetLength () const =0
 
- Public Member Functions inherited from IDatasmithSpotLightElement
virtual float GetInnerConeAngle () const =0
 
virtual void SetInnerConeAngle (float InnerConeAngle)=0
 
virtual float GetOuterConeAngle () const =0
 
virtual void SetOuterConeAngle (float OuterConeAngle)=0
 
- Public Member Functions inherited from IDatasmithPointLightElement
virtual void SetIntensityUnits (EDatasmithLightUnits InUnits)=0
 
virtual EDatasmithLightUnits GetIntensityUnits () const =0
 
virtual float GetSourceRadius () const =0
 
virtual void SetSourceRadius (float SourceRadius)=0
 
virtual float GetSourceLength () const =0
 
virtual void SetSourceLength (float SourceLength)=0
 
virtual float GetAttenuationRadius () const =0
 
virtual void SetAttenuationRadius (float AttenuationRadius)=0
 
- Public Member Functions inherited from IDatasmithLightActorElement
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
 

Detailed Description

An area light is an emissive shape (light shape) with a light component (light type)

Member Function Documentation

◆ GetLength()

virtual float IDatasmithAreaLightElement::GetLength ( ) const
pure virtual

◆ GetLightShape()

virtual EDatasmithLightShape IDatasmithAreaLightElement::GetLightShape ( ) const
pure virtual

Get the light shape Rectangle/Sphere/Disc/Cylinder

◆ GetLightType()

virtual EDatasmithAreaLightType IDatasmithAreaLightElement::GetLightType ( ) const
pure virtual

◆ GetWidth()

virtual float IDatasmithAreaLightElement::GetWidth ( ) const
pure virtual

◆ SetLength()

virtual void IDatasmithAreaLightElement::SetLength ( float  InLength)
pure virtual

Set the area light shape size on the X axis

◆ SetLightShape()

virtual void IDatasmithAreaLightElement::SetLightShape ( EDatasmithLightShape  Shape)
pure virtual

Set the light shape Rectangle/Sphere/Disc/Cylinder

◆ SetLightType()

virtual void IDatasmithAreaLightElement::SetLightType ( EDatasmithAreaLightType  LightType)
pure virtual

Set the type of light for an area light: Point/Spot/Rect

◆ SetWidth()

virtual void IDatasmithAreaLightElement::SetWidth ( float  InWidth)
pure virtual

Set the area light shape size on the Y axis


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