ActiViz .NET  5.8.0
Public Types | Public Member Functions | Static Public Member Functions | Public Attributes | Static Public Attributes | Protected Member Functions | Private Member Functions | Static Private Member Functions
Kitware.VTK.vtkXMLShader Class Reference

vtkXMLShader - encapsulates a Shader XML description. More...

Inheritance diagram for Kitware.VTK.vtkXMLShader:
[legend]
Collaboration diagram for Kitware.VTK.vtkXMLShader:
[legend]

List of all members.

Public Types

enum  LanguageCodes { LANGUAGE_CG = 2, LANGUAGE_GLSL = 3, LANGUAGE_MIXED = 1, LANGUAGE_NONE = 0 }
 Searches the file in the VTK_MATERIALS_DIRS. Note that this allocates new memory for the string. The caller must delete it. More...
enum  LocationCodes { LOCATION_FILE = 2, LOCATION_INLINE = 1, LOCATION_LIBRARY = 3, LOCATION_NONE = 0 }
 Searches the file in the VTK_MATERIALS_DIRS. Note that this allocates new memory for the string. The caller must delete it. More...
enum  ScopeCodes { SCOPE_FRAGMENT = 3, SCOPE_MIXED = 1, SCOPE_NONE = 0, SCOPE_VERTEX = 2 }
 Searches the file in the VTK_MATERIALS_DIRS. Note that this allocates new memory for the string. The caller must delete it. More...

Public Member Functions

 vtkXMLShader (IntPtr rawCppThis, bool callDisposalMethod, bool strong)
 Automatically generated constructor - called from generated code. DO NOT call directly.
 vtkXMLShader ()
 Undocumented Block.
string GetCode ()
 Get the shader code.
string GetEntry ()
 Get the entry point to the shader code as defined in the XML.
int GetLanguage ()
 Returns the shader's language as defined in the XML description.
int GetLocation ()
 Returns the location of the shader as defined in the XML description.
string GetName ()
 Get the name of the Shader.
virtual vtkXMLDataElement GetRootElement ()
 Get/Set the XML root element that describes this shader.
int GetScope ()
 Returns the type of the shader as defined in the XML description.
int GetStyle ()
 Returns the style of the shader as optionaly defined in the XML description. If not present, default style is 1. "style=2" means it is a shader without a main(). In style 2, the "main" function for the vertex shader part is void propFuncVS(void), the main function for the fragment shader part is void propFuncFS(). This is useful when combining a shader at the actor level and a shader defines at the renderer level, like the depth peeling pass.
override int IsA (string type)
 Undocumented Block.
new vtkXMLShader NewInstance ()
 Undocumented Block.
void SetRootElement (vtkXMLDataElement arg0)
 Get/Set the XML root element that describes this shader.

Static Public Member Functions

static new vtkXMLShader New ()
 Undocumented Block.
static new int IsTypeOf (string type)
 Undocumented Block.
static string LocateFile (string filename)
 Searches the file in the VTK_MATERIALS_DIRS. Note that this allocates new memory for the string. The caller must delete it.
static new vtkXMLShader SafeDownCast (vtkObjectBase o)
 Undocumented Block.

Public Attributes

new const string MRFullTypeName = "Kitware.VTK.vtkXMLShader"
 Automatically generated type registration mechanics.

Static Public Attributes

static new readonly string MRClassNameKey = "12vtkXMLShader"
 Automatically generated type registration mechanics.

Protected Member Functions

override void Dispose (bool disposing)
 Automatically generated protected Dispose method - called from public Dispose or the C# destructor. DO NOT call directly.

Private Member Functions

static internal IntPtr vtkXMLShader_New (ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount)
static internal IntPtr vtkXMLShader_GetCode_01 (HandleRef pThis)
static internal IntPtr vtkXMLShader_GetEntry_02 (HandleRef pThis)
static internal int vtkXMLShader_GetLanguage_03 (HandleRef pThis)
static internal int vtkXMLShader_GetLocation_04 (HandleRef pThis)
static internal IntPtr vtkXMLShader_GetName_05 (HandleRef pThis)
static internal IntPtr vtkXMLShader_GetRootElement_06 (HandleRef pThis, ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount)
static internal int vtkXMLShader_GetScope_07 (HandleRef pThis)
static internal int vtkXMLShader_GetStyle_08 (HandleRef pThis)
static internal int vtkXMLShader_IsA_09 (HandleRef pThis, string type)
static internal int vtkXMLShader_IsTypeOf_10 (string type)
static internal IntPtr vtkXMLShader_LocateFile_11 (string filename)
static internal IntPtr vtkXMLShader_NewInstance_13 (HandleRef pThis, ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount)
static internal IntPtr vtkXMLShader_SafeDownCast_14 (HandleRef o, ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount)
static internal void vtkXMLShader_SetRootElement_15 (HandleRef pThis, HandleRef arg0)

Static Private Member Functions

static vtkXMLShader ()
 Automatically generated type registration mechanics.

Detailed Description

vtkXMLShader - encapsulates a Shader XML description.

Description vtkXMLShader encapsulates the XML description for a Shader. It provides convenient access to various attributes/properties of a shader. Thanks Shader support in VTK includes key contributions by Gary Templet at Sandia National Labs.


Member Enumeration Documentation

Searches the file in the VTK_MATERIALS_DIRS. Note that this allocates new memory for the string. The caller must delete it.

Enumerator:
LANGUAGE_CG 

enum member

LANGUAGE_GLSL 

enum member

LANGUAGE_MIXED 

enum member

LANGUAGE_NONE 

enum member

Searches the file in the VTK_MATERIALS_DIRS. Note that this allocates new memory for the string. The caller must delete it.

Enumerator:
LOCATION_FILE 

enum member

LOCATION_INLINE 

enum member

LOCATION_LIBRARY 

enum member

LOCATION_NONE 

enum member

Searches the file in the VTK_MATERIALS_DIRS. Note that this allocates new memory for the string. The caller must delete it.

Enumerator:
SCOPE_FRAGMENT 

enum member

SCOPE_MIXED 

enum member

SCOPE_NONE 

enum member

SCOPE_VERTEX 

enum member


Constructor & Destructor Documentation

static Kitware.VTK.vtkXMLShader.vtkXMLShader ( ) [static, private]

Automatically generated type registration mechanics.

Kitware.VTK.vtkXMLShader.vtkXMLShader ( IntPtr  rawCppThis,
bool  callDisposalMethod,
bool  strong 
)

Automatically generated constructor - called from generated code. DO NOT call directly.

Undocumented Block.


Member Function Documentation

override void Kitware.VTK.vtkXMLShader.Dispose ( bool  disposing) [protected]

Automatically generated protected Dispose method - called from public Dispose or the C# destructor. DO NOT call directly.

Reimplemented from Kitware.VTK.vtkObject.

Get the shader code.

Get the entry point to the shader code as defined in the XML.

Returns the shader's language as defined in the XML description.

Returns the location of the shader as defined in the XML description.

Get the name of the Shader.

Get/Set the XML root element that describes this shader.

Here is the call graph for this function:

Returns the type of the shader as defined in the XML description.

Returns the style of the shader as optionaly defined in the XML description. If not present, default style is 1. "style=2" means it is a shader without a main(). In style 2, the "main" function for the vertex shader part is void propFuncVS(void), the main function for the fragment shader part is void propFuncFS(). This is useful when combining a shader at the actor level and a shader defines at the renderer level, like the depth peeling pass.

Postcondition:
valid_result: result==1 || result==2
override int Kitware.VTK.vtkXMLShader.IsA ( string  type) [virtual]

Undocumented Block.

Reimplemented from Kitware.VTK.vtkObject.

static new int Kitware.VTK.vtkXMLShader.IsTypeOf ( string  type) [static]

Undocumented Block.

Reimplemented from Kitware.VTK.vtkObject.

static string Kitware.VTK.vtkXMLShader.LocateFile ( string  filename) [static]

Searches the file in the VTK_MATERIALS_DIRS. Note that this allocates new memory for the string. The caller must delete it.

static new vtkXMLShader Kitware.VTK.vtkXMLShader.New ( ) [static]

Undocumented Block.

Reimplemented from Kitware.VTK.vtkObject.

Undocumented Block.

Reimplemented from Kitware.VTK.vtkObject.

Undocumented Block.

Reimplemented from Kitware.VTK.vtkObject.

Here is the call graph for this function:

Get/Set the XML root element that describes this shader.

static internal IntPtr Kitware.VTK.vtkXMLShader.vtkXMLShader_GetCode_01 ( HandleRef  pThis) [private]
static internal IntPtr Kitware.VTK.vtkXMLShader.vtkXMLShader_GetEntry_02 ( HandleRef  pThis) [private]
static internal int Kitware.VTK.vtkXMLShader.vtkXMLShader_GetLanguage_03 ( HandleRef  pThis) [private]
static internal int Kitware.VTK.vtkXMLShader.vtkXMLShader_GetLocation_04 ( HandleRef  pThis) [private]
static internal IntPtr Kitware.VTK.vtkXMLShader.vtkXMLShader_GetName_05 ( HandleRef  pThis) [private]
static internal IntPtr Kitware.VTK.vtkXMLShader.vtkXMLShader_GetRootElement_06 ( HandleRef  pThis,
ref uint  mteStatus,
ref uint  mteIndex,
ref uint  rawRefCount 
) [private]
static internal int Kitware.VTK.vtkXMLShader.vtkXMLShader_GetScope_07 ( HandleRef  pThis) [private]
static internal int Kitware.VTK.vtkXMLShader.vtkXMLShader_GetStyle_08 ( HandleRef  pThis) [private]
static internal int Kitware.VTK.vtkXMLShader.vtkXMLShader_IsA_09 ( HandleRef  pThis,
string  type 
) [private]
static internal int Kitware.VTK.vtkXMLShader.vtkXMLShader_IsTypeOf_10 ( string  type) [private]
static internal IntPtr Kitware.VTK.vtkXMLShader.vtkXMLShader_LocateFile_11 ( string  filename) [private]
static internal IntPtr Kitware.VTK.vtkXMLShader.vtkXMLShader_New ( ref uint  mteStatus,
ref uint  mteIndex,
ref uint  rawRefCount 
) [private]
static internal IntPtr Kitware.VTK.vtkXMLShader.vtkXMLShader_NewInstance_13 ( HandleRef  pThis,
ref uint  mteStatus,
ref uint  mteIndex,
ref uint  rawRefCount 
) [private]
static internal IntPtr Kitware.VTK.vtkXMLShader.vtkXMLShader_SafeDownCast_14 ( HandleRef  o,
ref uint  mteStatus,
ref uint  mteIndex,
ref uint  rawRefCount 
) [private]
static internal void Kitware.VTK.vtkXMLShader.vtkXMLShader_SetRootElement_15 ( HandleRef  pThis,
HandleRef  arg0 
) [private]

Member Data Documentation

new readonly string Kitware.VTK.vtkXMLShader.MRClassNameKey = "12vtkXMLShader" [static]

Automatically generated type registration mechanics.

Reimplemented from Kitware.VTK.vtkObject.

new const string Kitware.VTK.vtkXMLShader.MRFullTypeName = "Kitware.VTK.vtkXMLShader"

Automatically generated type registration mechanics.

Reimplemented from Kitware.VTK.vtkObject.


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