CSLXSITextureLayer Class Reference

This class represents an XSI_TextureLayer template. More...

#include <XSITextureLayer.h>

Inheritance diagram for CSLXSITextureLayer:

CSLTemplate CSIBCNode List of all members.

Public Member Functions
  CSLXSITextureLayer (CSLScene *in_pScene, CSLModel *in_pModel, CdotXSITemplate *in_pTemplate)
virtual  ~CSLXSITextureLayer ()
  Destructor.
SI_Error  Synchronize ()
ETemplateType  Type ()
virtual CSLAnimatableType *  ParameterFromName (SI_Char *in_szName)
virtual CSLAnimatableType *  ParameterFromType (EFCurveType in_Type, SI_Char *in_szParameterName)
SI_Int  GetOrder ()
SI_Void  SetOrder (SI_Int in_nValue)
SI_Bool  GetMute ()
SI_Void  SetMute (SI_Bool in_bValue)
SI_Bool  GetSolo ()
SI_Void  SetSolo (SI_Bool in_bValue)
SI_Char *  GetColorConnection ()
SI_Void  SetColorConnection (SI_Char *in_pValue)
SI_Float  GetRed ()
SI_Void  SetRed (SI_Float in_fValue)
SI_Float  GetGreen ()
SI_Void  SetGreen (SI_Float in_fValue)
SI_Float  GetBlue ()
SI_Void  SetBlue (SI_Float in_fValue)
SI_Float  GetAlpha ()
SI_Void  SetAlpha (SI_Float in_fValue)
SI_Bool  GetColorPremultiplied ()
SI_Void  SetColorPremultiplied (SI_Bool in_bValue)
SI_Bool  GetIgnoreColorAlpha ()
SI_Void  SetIgnoreColorAlpha (SI_Bool in_bValue)
SI_Bool  GetInvertColorAlpha ()
SI_Void  SetInvertColorAlpha (SI_Bool in_bValue)
SI_Bool  GetAlphaColor ()
SI_Void  SetAlphaColor (SI_Bool in_bValue)
SI_Char *  GetMaskConnection ()
SI_Void  SetMaskConnection (SI_Char *in_pValue)
SI_Float  GetMask ()
SI_Void  SetMask (SI_Float in_fValue)
SI_Bool  GetInvertMask ()
SI_Void  SetInvertMask (SI_Bool in_bValue)
SI_Int  GetMaskMode ()
SI_Void  SetMaskMode (SI_Int in_nValue)
SI_Float  GetMaskThreshold ()
SI_Void  SetMaskThreshold (SI_Float in_nValue)
SI_Float  GetWeight ()
SI_Void  SetWeight (SI_Float in_fValue)
SI_Int  GetMode ()
SI_Void  SetMode (SI_Int in_nValue)
CSLXSITextureLayerPort *  AddTextureLayerPort ()
SI_Error  RemoveTextureLayerPort (SI_Int in_nIndex)
SI_Error  RemoveTextureLayerPort (CSLXSITextureLayerPort *in_pToRemove)
CSLXSITextureLayerPort *  GetTextureLayerPort (SI_Int in_nIndex)
SI_Int  GetTextureLayerPortCount ()
SI_Error  ClearTextureLayerPorts ()
CSLXSITextureLayerPort **  GetTextureLayerPortList ()
CSLXSITextureLayerPort *  ConnectTextureLayerPort (CSLXSITextureLayerPort *in_pToConnect)
CSLXSIShaderMultiPortConnection *  AddMultiPortConnection ()
SI_Error  RemoveMultiPortConnection (SI_Int in_nIndex)
SI_Error  RemoveMultiPortConnection (CSLXSIShaderMultiPortConnection *in_pToRemove)
CSLXSIShaderMultiPortConnection *  GetMultiPortConnection (SI_Int in_nIndex)
SI_Int  GetMultiPortConnectionCount ()
SI_Error  ClearMultiPortConnections ()
CSLXSIShaderMultiPortConnection **  GetMultiPortConnectionList ()
CSLXSIShaderMultiPortConnection *  ConnectMultiPortConnection (CSLXSIShaderMultiPortConnection *in_pToConnect)
CSLXSIShaderMultiPortConnection *  FindMultiPortConnectionByParameterName (SI_Char *in_pName)

Detailed Description

This class represents an XSI_TextureLayer template.

Defines more image effects (see the XSI_TextureLayer template reference).

Since:
dotXSI 6.0

Constructor & Destructor Documentation

CSLXSITextureLayer ( CSLScene *  in_pScene,
CSLModel *  in_pModel,
CdotXSITemplate *  in_pTemplate  
)

Constructor

Parameters:
[in]  in_pScene  Parent scene
[in]  in_pModel  Parent model
[in]  in_pTemplate  Referred template

Member Function Documentation

SI_Error Synchronize (  )  [virtual]

Commits the current template information

Returns:
Whether or not the commit was successful

Reimplemented from CSLTemplate.

ETemplateType Type (  )  [inline, virtual]

Returns the type of this template

Return values:
CSLTemplate::XSI_TEXTURE_LAYER  The type of this template

Implements CSLTemplate.

virtual CSLAnimatableType* ParameterFromName ( SI_Char *  in_szName  )  [virtual]

Returns a proxy to the specified parameter.

Parameters:
[in]  in_szName  Name of the parameter
Returns:
Pointer to a parameter proxy.

Reimplemented from CSLTemplate.

virtual CSLAnimatableType* ParameterFromType ( EFCurveType  in_Type,
SI_Char *  in_szParameterName  
) [virtual]

Returns a proxy to the specified parameter.

Parameters:
[in]  in_Type  Type of parameter
[in]  in_szParameterName  Name of the parameter if the type is SI_PARAMETER
Returns:
Pointer to a parameter proxy.

Reimplemented from CSLTemplate.

SI_Int GetOrder (  ) 

Returns the Order value

Returns:
Order

SI_Void SetOrder ( SI_Int  in_nValue  ) 

Sets the Order value

Parameters:
[in]  in_nValue  new Order value

SI_Bool GetMute (  ) 

Returns the Mute value

Returns:
Mute

SI_Void SetMute ( SI_Bool  in_bValue  ) 

Sets the Mute value

Parameters:
[in]  in_bValue  new Mute value

SI_Bool GetSolo (  ) 

Returns the Solo value

Returns:
Solo

SI_Void SetSolo ( SI_Bool  in_bValue  ) 

Sets the Solo value

Parameters:
[in]  in_bValue  new Solo value

SI_Char* GetColorConnection (  ) 

Returns the ColorConnection value

Returns:
ColorConnection

SI_Void SetColorConnection ( SI_Char *  in_pValue  ) 

Sets the ColorConnection value

Parameters:
[in]  in_pValue  new ColorConnection value

SI_Float GetRed (  ) 

Returns the Red value

Returns:
Red

SI_Void SetRed ( SI_Float  in_fValue  ) 

Sets the Red value

Parameters:
[in]  in_fValue  new Red value

SI_Float GetGreen (  ) 

Returns the Green value

Returns:
Green

SI_Void SetGreen ( SI_Float  in_fValue  ) 

Sets the Green value

Parameters:
[in]  in_fValue  new Green value

SI_Float GetBlue (  ) 

Returns the Blue value

Returns:
Blue

SI_Void SetBlue ( SI_Float  in_fValue  ) 

Sets the Blue value

Parameters:
[in]  in_fValue  new Blue value

SI_Float GetAlpha (  ) 

Returns the Alpha value

Returns:
Alpha

SI_Void SetAlpha ( SI_Float  in_fValue  ) 

Sets the Alpha value

Parameters:
[in]  in_fValue  new Alpha value

SI_Bool GetColorPremultiplied (  ) 

Returns the ColorPremultiplied value

Returns:
ColorPremultiplied

SI_Void SetColorPremultiplied ( SI_Bool  in_bValue  ) 

Sets the ColorPremultiplied value

Parameters:
[in]  in_bValue  new ColorPremultiplied value

SI_Bool GetIgnoreColorAlpha (  ) 

Returns the IgnoreColorAlpha value

Returns:
IgnoreColorAlpha

SI_Void SetIgnoreColorAlpha ( SI_Bool  in_bValue  ) 

Sets the IgnoreColorAlpha value

Parameters:
[in]  in_bValue  new IgnoreColorAlpha value

SI_Bool GetInvertColorAlpha (  ) 

Returns the InvertColorAlpha value

Returns:
InvertColorAlpha

SI_Void SetInvertColorAlpha ( SI_Bool  in_bValue  ) 

Sets the InvertColorAlpha value

Parameters:
[in]  in_bValue  new InvertColorAlpha value

SI_Bool GetAlphaColor (  ) 

Returns the AlphaColor value

Returns:
AlphaColor

SI_Void SetAlphaColor ( SI_Bool  in_bValue  ) 

Sets the AlphaColor value

Parameters:
[in]  in_bValue  new AlphaColor value

SI_Char* GetMaskConnection (  ) 

Returns the MaskConnection value

Returns:
MaskConnection

SI_Void SetMaskConnection ( SI_Char *  in_pValue  ) 

Sets the MaskConnection value

Parameters:
[in]  in_pValue  new MaskConnection value

SI_Float GetMask (  ) 

Returns the Mask value

Returns:
Mask

SI_Void SetMask ( SI_Float  in_fValue  ) 

Sets the Mask value

Parameters:
[in]  in_fValue  new Mask value

SI_Bool GetInvertMask (  ) 

Returns the InvertMask value

Returns:
InvertMask

SI_Void SetInvertMask ( SI_Bool  in_bValue  ) 

Sets the InvertMask value

Parameters:
[in]  in_bValue  new InvertMask value

SI_Int GetMaskMode (  ) 

Returns the MaskMode value

Returns:
MaskMode

SI_Void SetMaskMode ( SI_Int  in_nValue  ) 

Sets the MaskMode value

Parameters:
[in]  in_nValue  new MaskMode value

SI_Float GetMaskThreshold (  ) 

Returns the MaskThreshold value

Returns:
MaskThreshold

SI_Void SetMaskThreshold ( SI_Float  in_nValue  ) 

Sets the MaskThreshold value

Parameters:
[in]  in_nValue  new MaskThreshold value

SI_Float GetWeight (  ) 

Returns the Weight value

Returns:
Weight

SI_Void SetWeight ( SI_Float  in_fValue  ) 

Sets the Weight value

Parameters:
[in]  in_fValue  new Weight value

SI_Int GetMode (  ) 

Returns the Mode value

Returns:
Mode

SI_Void SetMode ( SI_Int  in_nValue  ) 

Sets the Mode value

Parameters:
[in]  in_nValue  new Mode value

CSLXSITextureLayerPort* AddTextureLayerPort (  ) 

Adds a texture layer port to the texture layer port list

Returns:
The added texture layer port

SI_Error RemoveTextureLayerPort ( SI_Int  in_nIndex  ) 

Removes a texture layer port from the texture layer port list

Parameters:
[in]  in_nIndex  Index of the texture layer port to remove

SI_Error RemoveTextureLayerPort ( CSLXSITextureLayerPort *  in_pToRemove  ) 

Removes a texture layer port from the texture layer port list

Parameters:
[in]  in_pToRemove  The texture layer port to remove

CSLXSITextureLayerPort* GetTextureLayerPort ( SI_Int  in_nIndex  ) 

Returns the CSLXSITextureLayerPort object by index.

Parameters:
[in]  in_nIndex  Index of the texture layer port to get
Returns:
The CSLXSITextureLayerPort.

SI_Int GetTextureLayerPortCount (  ) 

Returns the number of texture layer port in the texture layer port list

Returns:
The number of texture layer port in the texture layer port list

SI_Error ClearTextureLayerPorts (  ) 

Deletes all the texture layer port form the texture layer port list

CSLXSITextureLayerPort** GetTextureLayerPortList (  ) 

Returns a pointer to the internally-stored texture layer port pointer list

Returns:
Pointer to the list

CSLXSITextureLayerPort* ConnectTextureLayerPort ( CSLXSITextureLayerPort *  in_pToConnect  ) 

Adds an exisiting texture layer port to the texture layer port list

Parameters:
[in]  in_pToConnect  Pointer to the texture layer port to add
Returns:
The added texture layer port

CSLXSIShaderMultiPortConnection* AddMultiPortConnection (  ) 

Adds a multi port connection to the multi port connection list

Returns:
The added multi port connection

SI_Error RemoveMultiPortConnection ( SI_Int  in_nIndex  ) 

Removes a multi port connection from the multi port connection list

Parameters:
[in]  in_nIndex  Index of the multi port connection to remove

SI_Error RemoveMultiPortConnection ( CSLXSIShaderMultiPortConnection *  in_pToRemove  ) 

Removes a multi port connection from the multi port connection list

Parameters:
[in]  in_pToRemove  The multi port connection to remove

CSLXSIShaderMultiPortConnection* GetMultiPortConnection ( SI_Int  in_nIndex  ) 

Returns the CSLXSIShaderMultiPortConnection object of a given multi port connection by index.

Parameters:
[in]  in_nIndex  Index of the multi port connection to get
Returns:
The CSLXSIShaderMultiPortConnection that holds the name and the type of a multi port connection.

SI_Int GetMultiPortConnectionCount (  ) 

Returns the number of multi port connection in the multi port connection list

Returns:
The number of multi port connection in the multi port connection list

SI_Error ClearMultiPortConnections (  ) 

Deletes all the multi port connection form the multi port connection list

CSLXSIShaderMultiPortConnection** GetMultiPortConnectionList (  ) 

Returns a pointer to the internally-stored multi port connection pointer list

Returns:
Pointer to the list

CSLXSIShaderMultiPortConnection* ConnectMultiPortConnection ( CSLXSIShaderMultiPortConnection *  in_pToConnect  ) 

Adds an exisiting multi port connection to the multi port connection list

Parameters:
[in]  in_pToConnect  Pointer to the multi port connection to add
Returns:
The added multi port connection

CSLXSIShaderMultiPortConnection* FindMultiPortConnectionByParameterName ( SI_Char *  in_pName  ) 

Searches the multi port connection list for one with a corresponding parameter name

Parameters:
[in]  in_pName  The parameter name to look for
Returns:
Pointer on the multi port connection if found, NULL if not found

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