FDatasmithCompositeTextureImpl Class Reference
Inheritance diagram for FDatasmithCompositeTextureImpl:
IDatasmithCompositeTexture

Public Member Functions

virtual bool IsValid () const override
 Gets the validity of the composite texture. More...
 
virtual EDatasmithCompMode GetMode () const override
 Gets the composition mode like color correction etc. More...
 
virtual void SetMode (EDatasmithCompMode InMode) override
 Sets the composition mode like color correction etc. More...
 
virtual int32 GetParamSurfacesCount () const override
 Get the number of surfaces. More...
 
virtual bool GetUseTexture (int32 InIndex) override
 Gets texture usage. More...
 
virtual const TCHAR * GetParamTexture (int32 InIndex) override
 Get the filename of the i-th texture. More...
 
virtual void SetParamTexture (int32 InIndex, const TCHAR *InTexture) override
 Sets the new texture for the index-th item. More...
 
virtual FDatasmithTextureSamplerGetParamTextureSampler (int32 InIndex) override
 Get the i-th uv element. More...
 
virtual bool GetUseColor (int32 InIndex) override
 Gets color usage. More...
 
virtual const FLinearColor & GetParamColor (int32 InIndex) override
 Get the i-th color in linear space. More...
 
virtual bool GetUseComposite (int32 InIndex) override
 Returns true if composite texture should be used. More...
 
virtual int32 GetParamVal1Count () const override
 Get the number of value1 parameters. More...
 
virtual ParamVal GetParamVal1 (int32 InIndex) const override
 Get the i-th Value1 parameter. More...
 
virtual void AddParamVal1 (ParamVal InParamVal) override
 Add a new Value1 parameter. More...
 
virtual int32 GetParamVal2Count () const override
 Get the number of value2 parameters. More...
 
virtual ParamVal GetParamVal2 (int32 InIndex) const override
 Get the Value2 parameter. More...
 
virtual void AddParamVal2 (ParamVal InParamVal) override
 Add a new Value2 parameter. More...
 
virtual int32 GetParamMaskSurfacesCount () const override
 Get the amount of layer masks. More...
 
virtual const TCHAR * GetParamMask (int32 InIndex) override
 Get the i-th layer mask's filename. More...
 
virtual const FLinearColor & GetParamMaskColor (int32 i) const override
 Get the i-th color in linear space. More...
 
virtual bool GetMaskUseComposite (int32 InIndex) const override
 Returns true if composite texture mask should be used. More...
 
virtual void AddMaskSurface (const TCHAR *InMask, const FDatasmithTextureSampler InMaskSampler) override
 Adds a new layer mask from its filename. More...
 
virtual void AddMaskSurface (const FLinearColor &InColor) override
 Creates a new surface to be used as mask that will be used as layer inside this composite using a color in linear space. More...
 
virtual FDatasmithTextureSampler GetParamMaskTextureSampler (int32 InIndex) override
 Get the ith layer mask's uv element. More...
 
virtual TSharedPtr< IDatasmithCompositeTexture > & GetParamSubComposite (int32 InIndex) override
 Get the i-th nested composite texture. More...
 
virtual void AddSurface (const TSharedPtr< IDatasmithCompositeTexture > &SubComp) override
 Adds a new nested composite texture. More...
 
virtual TSharedPtr< IDatasmithCompositeTexture > & GetParamMaskSubComposite (int32 InIndex) override
 Get the ith composite texture inside this composite used as layer mask. More...
 
virtual void AddMaskSurface (const TSharedPtr< IDatasmithCompositeTexture > &InMaskSubComp) override
 Adds a new composite texture inside this composite used as layer mask. More...
 
virtual const TCHAR * GetBaseTextureName () const override
 Returns the string that identifies the texture element. More...
 
virtual const TCHAR * GetBaseColName () const override
 Returns the string that identifies the color element. More...
 
virtual const TCHAR * GetBaseValName () const override
 Returns the string that identifies the value element. More...
 
virtual const TCHAR * GetBaseCompName () const override
 Returns the string that identifies the composite element. More...
 
virtual void SetBaseNames (const TCHAR *InTextureName, const TCHAR *InColorName, const TCHAR *InValueName, const TCHAR *InCompName) override
 Sets the strings that identifies the different elements on this composite. More...
 
virtual void AddSurface (const TCHAR *InTexture, FDatasmithTextureSampler InTexUV) override
 Creates a new surface that will be used as layer inside this composite using the texture filename and its uv element. More...
 
virtual void AddSurface (const FLinearColor &InColor) override
 Creates a new surface that will be used as layer inside this composite using a color in linear space. More...
 
virtual void ClearSurface () override
 Purges all the surfaces that could be used as layers inside this composite. More...
 

Additional Inherited Members

- Public Types inherited from IDatasmithCompositeTexture
typedef TPair< float, const TCHAR * > ParamVal
 

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()

virtual 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()

virtual const FLinearColor& FDatasmithCompositeTextureImpl::GetParamColor ( int32  i)
overridevirtual

Get the i-th color in linear space.

Implements IDatasmithCompositeTexture.

◆ GetParamMask()

virtual const TCHAR* FDatasmithCompositeTextureImpl::GetParamMask ( int32  i)
overridevirtual

Get the i-th layer mask's filename.

Implements IDatasmithCompositeTexture.

◆ GetParamMaskColor()

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

Get the i-th color in linear space.

Implements IDatasmithCompositeTexture.

◆ GetParamMaskSubComposite()

virtual 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()

virtual FDatasmithTextureSampler FDatasmithCompositeTextureImpl::GetParamMaskTextureSampler ( int32  i)
overridevirtual

Get the ith layer mask's uv element.

Implements IDatasmithCompositeTexture.

◆ GetParamSubComposite()

virtual 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()

virtual const TCHAR* FDatasmithCompositeTextureImpl::GetParamTexture ( int32  i)
overridevirtual

Get the filename of the i-th texture.

Implements IDatasmithCompositeTexture.

◆ GetParamTextureSampler()

virtual FDatasmithTextureSampler& FDatasmithCompositeTextureImpl::GetParamTextureSampler ( int32  i)
overridevirtual

Get the i-th uv element.

Implements IDatasmithCompositeTexture.

◆ GetParamVal1()

virtual 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()

virtual 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()

virtual bool FDatasmithCompositeTextureImpl::GetUseColor ( int32  i)
overridevirtual

Gets color usage.

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

Implements IDatasmithCompositeTexture.

◆ GetUseComposite()

virtual bool FDatasmithCompositeTextureImpl::GetUseComposite ( int32  i)
overridevirtual

Returns true if composite texture should be used.

Implements IDatasmithCompositeTexture.

◆ GetUseTexture()

virtual 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()

virtual 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()

virtual 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
InTextureNamefor plain textures
InColorNamefor color elements
InValueNamefor regular float values
InCompNamefor 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()

virtual 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 file: