FDatasmithCompositeTextureImpl Class Reference

#include <DatasmithSceneElementsImpl.h>

Inheritance diagram for FDatasmithCompositeTextureImpl:

Public Member Functions
	FDatasmithCompositeTextureImpl ()
virtual bool	IsValid () const override
virtual EDatasmithCompMode	GetMode () const override
virtual void	SetMode (EDatasmithCompMode InMode) override
virtual int32	GetParamSurfacesCount () const override
virtual bool	GetUseTexture (int32 InIndex) override
virtual const TCHAR *	GetParamTexture (int32 InIndex) override
virtual void	SetParamTexture (int32 InIndex, const TCHAR *InTexture) override
virtual FDatasmithTextureSampler &	GetParamTextureSampler (int32 InIndex) override
virtual bool	GetUseColor (int32 InIndex) override
virtual const FLinearColor &	GetParamColor (int32 InIndex) override
virtual bool	GetUseComposite (int32 InIndex) override
virtual int32	GetParamVal1Count () const override
virtual ParamVal	GetParamVal1 (int32 InIndex) const override
virtual void	AddParamVal1 (ParamVal InParamVal) override
virtual int32	GetParamVal2Count () const override
virtual ParamVal	GetParamVal2 (int32 InIndex) const override
virtual void	AddParamVal2 (ParamVal InParamVal) override
virtual int32	GetParamMaskSurfacesCount () const override
virtual const TCHAR *	GetParamMask (int32 InIndex) override
virtual const FLinearColor &	GetParamMaskColor (int32 i) const override
virtual bool	GetMaskUseComposite (int32 InIndex) const override
virtual void	AddMaskSurface (const TCHAR *InMask, const FDatasmithTextureSampler InMaskSampler) override
virtual void	AddMaskSurface (const FLinearColor &InColor) override
virtual FDatasmithTextureSampler	GetParamMaskTextureSampler (int32 InIndex) override
virtual TSharedPtr< IDatasmithCompositeTexture > &	GetParamSubComposite (int32 InIndex) override
virtual void	AddSurface (const TSharedPtr< IDatasmithCompositeTexture > &SubComp) override
virtual TSharedPtr< IDatasmithCompositeTexture > &	GetParamMaskSubComposite (int32 InIndex) override
virtual void	AddMaskSurface (const TSharedPtr< IDatasmithCompositeTexture > &InMaskSubComp) override
virtual const TCHAR *	GetBaseTextureName () const override
virtual const TCHAR *	GetBaseColName () const override
virtual const TCHAR *	GetBaseValName () const override
virtual const TCHAR *	GetBaseCompName () const override
virtual void	SetBaseNames (const TCHAR *InTextureName, const TCHAR *InColorName, const TCHAR *InValueName, const TCHAR *InCompName) override
virtual void	AddSurface (const TCHAR *InTexture, FDatasmithTextureSampler InTexUV) override
virtual void	AddSurface (const FLinearColor &InColor) override
virtual void	ClearSurface () override
Public Member Functions inherited from IDatasmithCompositeTexture
virtual	~IDatasmithCompositeTexture ()

Additional Inherited Members
Public Types inherited from IDatasmithCompositeTexture
typedef TPair< float, const TCHAR * >	ParamVal

Constructor & Destructor Documentation

FDatasmithCompositeTextureImpl()

FDatasmithCompositeTextureImpl::FDatasmithCompositeTextureImpl

(

)

Member Function Documentation

AddMaskSurface() [1/3]

virtual void FDatasmithCompositeTextureImpl::AddMaskSurface ( const FLinearColor &  Color )

inlineoverridevirtual

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

Implements IDatasmithCompositeTexture.

AddMaskSurface() [2/3]

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

inlineoverridevirtual

Adds a new layer mask from its filename

Implements IDatasmithCompositeTexture.

AddMaskSurface() [3/3]

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

inlineoverridevirtual

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

Implements IDatasmithCompositeTexture.

AddParamVal1()

virtual void FDatasmithCompositeTextureImpl::AddParamVal1 ( ParamVal  InParamVal )

inlineoverridevirtual

Add a new Value1 parameter

Implements IDatasmithCompositeTexture.

AddParamVal2()

virtual void FDatasmithCompositeTextureImpl::AddParamVal2 ( ParamVal  InParamVal )

inlineoverridevirtual

Add a new Value2 parameter

Implements IDatasmithCompositeTexture.

AddSurface() [1/3]

virtual void FDatasmithCompositeTextureImpl::AddSurface ( const FLinearColor &  Color )

inlineoverridevirtual

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

Implements IDatasmithCompositeTexture.

AddSurface() [2/3]

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

inlineoverridevirtual

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

Implements IDatasmithCompositeTexture.

AddSurface() [3/3]

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

inlineoverridevirtual

Adds a new nested composite texture

Implements IDatasmithCompositeTexture.

ClearSurface()

virtual void FDatasmithCompositeTextureImpl::ClearSurface ( )

inlineoverridevirtual

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

Implements IDatasmithCompositeTexture.

GetBaseColName()

virtual const TCHAR * FDatasmithCompositeTextureImpl::GetBaseColName ( ) const

inlineoverridevirtual

Returns the string that identifies the color element

Implements IDatasmithCompositeTexture.

GetBaseCompName()

virtual const TCHAR * FDatasmithCompositeTextureImpl::GetBaseCompName ( ) const

inlineoverridevirtual

Returns the string that identifies the composite element

Implements IDatasmithCompositeTexture.

GetBaseTextureName()

virtual const TCHAR * FDatasmithCompositeTextureImpl::GetBaseTextureName ( ) const

inlineoverridevirtual

Returns the string that identifies the texture element

Implements IDatasmithCompositeTexture.

GetBaseValName()

virtual const TCHAR * FDatasmithCompositeTextureImpl::GetBaseValName ( ) const

inlineoverridevirtual

Returns the string that identifies the value element

Implements IDatasmithCompositeTexture.

GetMaskUseComposite()

bool FDatasmithCompositeTextureImpl::GetMaskUseComposite ( int32  i ) const

overridevirtual

Returns true if composite texture mask should be used

Implements IDatasmithCompositeTexture.

GetMode()

virtual EDatasmithCompMode FDatasmithCompositeTextureImpl::GetMode ( ) const

inlineoverridevirtual

Gets the composition mode like color correction etc

Implements IDatasmithCompositeTexture.

GetParamColor()

const FLinearColor & FDatasmithCompositeTextureImpl::GetParamColor ( int32  i )

overridevirtual

Get the i-th color in linear space

Implements IDatasmithCompositeTexture.

GetParamMask()

const TCHAR * FDatasmithCompositeTextureImpl::GetParamMask ( int32  i )

overridevirtual

Get the i-th layer mask's filename

Implements IDatasmithCompositeTexture.

GetParamMaskColor()

const FLinearColor & FDatasmithCompositeTextureImpl::GetParamMaskColor ( int32  i ) const

overridevirtual

Get the i-th color in linear space

Implements IDatasmithCompositeTexture.

GetParamMaskSubComposite()

TSharedPtr< IDatasmithCompositeTexture > & FDatasmithCompositeTextureImpl::GetParamMaskSubComposite ( int32  i )

overridevirtual

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

Implements IDatasmithCompositeTexture.

GetParamMaskSurfacesCount()

virtual int32 FDatasmithCompositeTextureImpl::GetParamMaskSurfacesCount ( ) const

inlineoverridevirtual

Get the amount of layer masks

Implements IDatasmithCompositeTexture.

GetParamMaskTextureSampler()

FDatasmithTextureSampler FDatasmithCompositeTextureImpl::GetParamMaskTextureSampler ( int32  i )

overridevirtual

Get the ith layer mask's uv element

Implements IDatasmithCompositeTexture.

GetParamSubComposite()

TSharedPtr< IDatasmithCompositeTexture > & FDatasmithCompositeTextureImpl::GetParamSubComposite ( int32  i )

overridevirtual

Get the i-th nested composite texture

Implements IDatasmithCompositeTexture.

GetParamSurfacesCount()

virtual int32 FDatasmithCompositeTextureImpl::GetParamSurfacesCount ( ) const

inlineoverridevirtual

Get the number of surfaces.

Implements IDatasmithCompositeTexture.

GetParamTexture()

const TCHAR * FDatasmithCompositeTextureImpl::GetParamTexture ( int32  i )

overridevirtual

Get the filename of the i-th texture

Implements IDatasmithCompositeTexture.

GetParamTextureSampler()

FDatasmithTextureSampler & FDatasmithCompositeTextureImpl::GetParamTextureSampler ( int32  i )

overridevirtual

Get the i-th uv element

Implements IDatasmithCompositeTexture.

GetParamVal1()

IDatasmithCompositeTexture::ParamVal FDatasmithCompositeTextureImpl::GetParamVal1 ( int32  i ) const

overridevirtual

Get the i-th Value1 parameter

Implements IDatasmithCompositeTexture.

GetParamVal1Count()

virtual int32 FDatasmithCompositeTextureImpl::GetParamVal1Count ( ) const

inlineoverridevirtual

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.

Implements IDatasmithCompositeTexture.

GetParamVal2()

IDatasmithCompositeTexture::ParamVal FDatasmithCompositeTextureImpl::GetParamVal2 ( int32  i ) const

overridevirtual

Get the Value2 parameter

Implements IDatasmithCompositeTexture.

GetParamVal2Count()

virtual int32 FDatasmithCompositeTextureImpl::GetParamVal2Count ( ) const

inlineoverridevirtual

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.

Implements IDatasmithCompositeTexture.

GetUseColor()

bool FDatasmithCompositeTextureImpl::GetUseColor ( int32  i )

overridevirtual

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

Implements IDatasmithCompositeTexture.

GetUseComposite()

bool FDatasmithCompositeTextureImpl::GetUseComposite ( int32  i )

overridevirtual

Returns true if composite texture should be used

Implements IDatasmithCompositeTexture.

GetUseTexture()

bool FDatasmithCompositeTextureImpl::GetUseTexture ( int32  i )

overridevirtual

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

Implements IDatasmithCompositeTexture.

IsValid()

bool FDatasmithCompositeTextureImpl::IsValid ( ) const

overridevirtual

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

Implements IDatasmithCompositeTexture.

SetBaseNames()

void FDatasmithCompositeTextureImpl::SetBaseNames ( const TCHAR *  InTextureName, const TCHAR *  InColorName, const TCHAR *  InValueName, const TCHAR *  InCompName  )

overridevirtual

Sets the strings that identifies the different elements on this composite

Parameters

InTextureName	for plain textures
InColorName	for color elements
InValueName	for regular float values
InCompName	for nested composite elements inside this composite

Implements IDatasmithCompositeTexture.

SetMode()

virtual void FDatasmithCompositeTextureImpl::SetMode ( EDatasmithCompMode  Mode )

inlineoverridevirtual

Sets the composition mode like color correction etc

Implements IDatasmithCompositeTexture.

SetParamTexture()

void FDatasmithCompositeTextureImpl::SetParamTexture ( int32  InIndex, const TCHAR *  InTexture  )

overridevirtual

Sets the new texture for the index-th item

Implements IDatasmithCompositeTexture.

---

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

• Engine/Source/Runtime/Datasmith/DatasmithCore/Private/DatasmithSceneElementsImpl.h
• Engine/Source/Runtime/Datasmith/DatasmithCore/Private/DatasmithSceneElementsImpl.cpp