UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
Public Types | Public Member Functions | List of all members
IDatasmithCompositeTexture Class Referenceabstract

#include <IDatasmithSceneElements.h>

+ Inheritance diagram for IDatasmithCompositeTexture:

Public Types

typedef TPair< float, const TCHAR * > ParamVal
 

Public Member Functions

virtual ~IDatasmithCompositeTexture ()
 
virtual bool IsValid () const =0
 
virtual EDatasmithCompMode GetMode () const =0
 
virtual void SetMode (EDatasmithCompMode Mode)=0
 
virtual int32 GetParamSurfacesCount () const =0
 
virtual bool GetUseTexture (int32 i)=0
 
virtual const TCHAR * GetParamTexture (int32 i)=0
 
virtual void SetParamTexture (int32 InIndex, const TCHAR *InTexture)=0
 
virtual FDatasmithTextureSampler & GetParamTextureSampler (int32 i)=0
 
virtual bool GetUseColor (int32 i)=0
 
virtual const FLinearColor & GetParamColor (int32 i)=0
 
virtual bool GetUseComposite (int32 i)=0
 
virtual int32 GetParamVal1Count () const =0
 
virtual ParamVal GetParamVal1 (int32 i) const =0
 
virtual void AddParamVal1 (ParamVal InParamVal)=0
 
virtual int32 GetParamVal2Count () const =0
 
virtual ParamVal GetParamVal2 (int32 i) const =0
 
virtual void AddParamVal2 (ParamVal InParamVal)=0
 
virtual TSharedPtr< IDatasmithCompositeTexture > & GetParamSubComposite (int32 i)=0
 
virtual void AddSurface (const TSharedPtr< IDatasmithCompositeTexture > &SubComp)=0
 
virtual int32 GetParamMaskSurfacesCount () const =0
 
virtual const TCHAR * GetParamMask (int32 i)=0
 
virtual void AddMaskSurface (const TCHAR *InMask, const FDatasmithTextureSampler InMaskSampler)=0
 
virtual FDatasmithTextureSampler GetParamMaskTextureSampler (int32 i)=0
 
virtual TSharedPtr< IDatasmithCompositeTexture > & GetParamMaskSubComposite (int32 i)=0
 
virtual const FLinearColor & GetParamMaskColor (int32 i) const =0
 
virtual bool GetMaskUseComposite (int32 i) const =0
 
virtual void AddMaskSurface (const TSharedPtr< IDatasmithCompositeTexture > &MaskSubComp)=0
 
virtual void AddMaskSurface (const FLinearColor &Color)=0
 
virtual const TCHAR * GetBaseTextureName () const =0
 
virtual const TCHAR * GetBaseColName () const =0
 
virtual const TCHAR * GetBaseValName () const =0
 
virtual const TCHAR * GetBaseCompName () const =0
 
virtual void SetBaseNames (const TCHAR *InTextureName, const TCHAR *InColorName, const TCHAR *InValueName, const TCHAR *InCompName)=0
 
virtual void AddSurface (const TCHAR *Texture, FDatasmithTextureSampler TexUV)=0
 
virtual void AddSurface (const FLinearColor &Color)=0
 
virtual void ClearSurface ()=0
 

Member Typedef Documentation

◆ ParamVal

typedef TPair<float, const TCHAR*> IDatasmithCompositeTexture::ParamVal

Constructor & Destructor Documentation

◆ ~IDatasmithCompositeTexture()

virtual IDatasmithCompositeTexture::~IDatasmithCompositeTexture ( )
inlinevirtual

Member Function Documentation

◆ AddMaskSurface() [1/3]

virtual void IDatasmithCompositeTexture::AddMaskSurface ( const FLinearColor &  Color)
pure virtual

Creates a new surface to be used as mask that will be used as layer inside this composite using a color in linear space.

Implemented in FDatasmithCompositeTextureImpl.

◆ AddMaskSurface() [2/3]

virtual void IDatasmithCompositeTexture::AddMaskSurface ( const TCHAR *  InMask,
const FDatasmithTextureSampler  InMaskSampler 
)
pure virtual

Adds a new layer mask from its filename

Implemented in FDatasmithCompositeTextureImpl.

◆ AddMaskSurface() [3/3]

virtual void IDatasmithCompositeTexture::AddMaskSurface ( const TSharedPtr< IDatasmithCompositeTexture > &  MaskSubComp)
pure virtual

Adds a new composite texture inside this composite used as layer mask

Implemented in FDatasmithCompositeTextureImpl.

◆ AddParamVal1()

virtual void IDatasmithCompositeTexture::AddParamVal1 ( ParamVal  InParamVal)
pure virtual

Add a new Value1 parameter

Implemented in FDatasmithCompositeTextureImpl.

◆ AddParamVal2()

virtual void IDatasmithCompositeTexture::AddParamVal2 ( ParamVal  InParamVal)
pure virtual

Add a new Value2 parameter

Implemented in FDatasmithCompositeTextureImpl.

◆ AddSurface() [1/3]

virtual void IDatasmithCompositeTexture::AddSurface ( const FLinearColor &  Color)
pure virtual

Creates a new surface that will be used as layer inside this composite using a color in linear space.

Implemented in FDatasmithCompositeTextureImpl.

◆ AddSurface() [2/3]

virtual void IDatasmithCompositeTexture::AddSurface ( const TCHAR *  Texture,
FDatasmithTextureSampler  TexUV 
)
pure virtual

Creates a new surface that will be used as layer inside this composite using the texture filename and its uv element.

Implemented in FDatasmithCompositeTextureImpl.

◆ AddSurface() [3/3]

virtual void IDatasmithCompositeTexture::AddSurface ( const TSharedPtr< IDatasmithCompositeTexture > &  SubComp)
pure virtual

Adds a new nested composite texture

Implemented in FDatasmithCompositeTextureImpl.

◆ ClearSurface()

virtual void IDatasmithCompositeTexture::ClearSurface ( )
pure virtual

Purges all the surfaces that could be used as layers inside this composite.

Implemented in FDatasmithCompositeTextureImpl.

◆ GetBaseColName()

virtual const TCHAR * IDatasmithCompositeTexture::GetBaseColName ( ) const
pure virtual

Returns the string that identifies the color element

Implemented in FDatasmithCompositeTextureImpl.

◆ GetBaseCompName()

virtual const TCHAR * IDatasmithCompositeTexture::GetBaseCompName ( ) const
pure virtual

Returns the string that identifies the composite element

Implemented in FDatasmithCompositeTextureImpl.

◆ GetBaseTextureName()

virtual const TCHAR * IDatasmithCompositeTexture::GetBaseTextureName ( ) const
pure virtual

Returns the string that identifies the texture element

Implemented in FDatasmithCompositeTextureImpl.

◆ GetBaseValName()

virtual const TCHAR * IDatasmithCompositeTexture::GetBaseValName ( ) const
pure virtual

Returns the string that identifies the value element

Implemented in FDatasmithCompositeTextureImpl.

◆ GetMaskUseComposite()

virtual bool IDatasmithCompositeTexture::GetMaskUseComposite ( int32  i) const
pure virtual

Returns true if composite texture mask should be used

Implemented in FDatasmithCompositeTextureImpl.

◆ GetMode()

virtual EDatasmithCompMode IDatasmithCompositeTexture::GetMode ( ) const
pure virtual

Gets the composition mode like color correction etc

Implemented in FDatasmithCompositeTextureImpl.

◆ GetParamColor()

virtual const FLinearColor & IDatasmithCompositeTexture::GetParamColor ( int32  i)
pure virtual

Get the i-th color in linear space

Implemented in FDatasmithCompositeTextureImpl.

◆ GetParamMask()

virtual const TCHAR * IDatasmithCompositeTexture::GetParamMask ( int32  i)
pure virtual

Get the i-th layer mask's filename

Implemented in FDatasmithCompositeTextureImpl.

◆ GetParamMaskColor()

virtual const FLinearColor & IDatasmithCompositeTexture::GetParamMaskColor ( int32  i) const
pure virtual

Get the i-th color in linear space

Implemented in FDatasmithCompositeTextureImpl.

◆ GetParamMaskSubComposite()

virtual TSharedPtr< IDatasmithCompositeTexture > & IDatasmithCompositeTexture::GetParamMaskSubComposite ( int32  i)
pure virtual

Get the ith composite texture inside this composite used as layer mask

Implemented in FDatasmithCompositeTextureImpl.

◆ GetParamMaskSurfacesCount()

virtual int32 IDatasmithCompositeTexture::GetParamMaskSurfacesCount ( ) const
pure virtual

Get the amount of layer masks

Implemented in FDatasmithCompositeTextureImpl.

◆ GetParamMaskTextureSampler()

virtual FDatasmithTextureSampler IDatasmithCompositeTexture::GetParamMaskTextureSampler ( int32  i)
pure virtual

Get the ith layer mask's uv element

Implemented in FDatasmithCompositeTextureImpl.

◆ GetParamSubComposite()

virtual TSharedPtr< IDatasmithCompositeTexture > & IDatasmithCompositeTexture::GetParamSubComposite ( int32  i)
pure virtual

Get the i-th nested composite texture

Implemented in FDatasmithCompositeTextureImpl.

◆ GetParamSurfacesCount()

virtual int32 IDatasmithCompositeTexture::GetParamSurfacesCount ( ) const
pure virtual

Get the number of surfaces.

Implemented in FDatasmithCompositeTextureImpl.

◆ GetParamTexture()

virtual const TCHAR * IDatasmithCompositeTexture::GetParamTexture ( int32  i)
pure virtual

Get the filename of the i-th texture

Implemented in FDatasmithCompositeTextureImpl.

◆ GetParamTextureSampler()

virtual FDatasmithTextureSampler & IDatasmithCompositeTexture::GetParamTextureSampler ( int32  i)
pure virtual

Get the i-th uv element

Implemented in FDatasmithCompositeTextureImpl.

◆ GetParamVal1()

virtual ParamVal IDatasmithCompositeTexture::GetParamVal1 ( int32  i) const
pure virtual

Get the i-th Value1 parameter

Implemented in FDatasmithCompositeTextureImpl.

◆ GetParamVal1Count()

virtual int32 IDatasmithCompositeTexture::GetParamVal1Count ( ) const
pure virtual

Get the number of value1 parameters. Some composites will use no values, other types could use only one value, and others could use two values.

Implemented in FDatasmithCompositeTextureImpl.

◆ GetParamVal2()

virtual ParamVal IDatasmithCompositeTexture::GetParamVal2 ( int32  i) const
pure virtual

Get the Value2 parameter

Implemented in FDatasmithCompositeTextureImpl.

◆ GetParamVal2Count()

virtual int32 IDatasmithCompositeTexture::GetParamVal2Count ( ) const
pure virtual

Get the number of value2 parameters. Some composites will use no values, other types could use only one value, and others could use two values.

Implemented in FDatasmithCompositeTextureImpl.

◆ GetUseColor()

virtual bool IDatasmithCompositeTexture::GetUseColor ( int32  i)
pure virtual

Gets color usage. If true color is used, else a value is used.

Implemented in FDatasmithCompositeTextureImpl.

◆ GetUseComposite()

virtual bool IDatasmithCompositeTexture::GetUseComposite ( int32  i)
pure virtual

Returns true if composite texture should be used

Implemented in FDatasmithCompositeTextureImpl.

◆ GetUseTexture()

virtual bool IDatasmithCompositeTexture::GetUseTexture ( int32  i)
pure virtual

Gets texture usage. If it returns false you should use a value or a color checking GetUseColor(i).

Implemented in FDatasmithCompositeTextureImpl.

◆ IsValid()

virtual bool IDatasmithCompositeTexture::IsValid ( ) const
pure virtual

Gets the validity of the composite texture. If it returns false probably you should use the regular texture or color.

Implemented in FDatasmithCompositeTextureImpl.

◆ SetBaseNames()

virtual void IDatasmithCompositeTexture::SetBaseNames ( const TCHAR *  InTextureName,
const TCHAR *  InColorName,
const TCHAR *  InValueName,
const TCHAR *  InCompName 
)
pure virtual

Sets the strings that identifies the different elements on this composite

Parameters
InTextureNamefor plain textures
InColorNamefor color elements
InValueNamefor regular float values
InCompNamefor nested composite elements inside this composite

Implemented in FDatasmithCompositeTextureImpl.

◆ SetMode()

virtual void IDatasmithCompositeTexture::SetMode ( EDatasmithCompMode  Mode)
pure virtual

Sets the composition mode like color correction etc

Implemented in FDatasmithCompositeTextureImpl.

◆ SetParamTexture()

virtual void IDatasmithCompositeTexture::SetParamTexture ( int32  InIndex,
const TCHAR *  InTexture 
)
pure virtual

Sets the new texture for the index-th item

Implemented in FDatasmithCompositeTextureImpl.

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