Initial commit

Torque/SDK/lib/mayasdk4/include/maya/MPxHwShaderNode.h

@@ -0,0 +1,225 @@
+#ifndef LINUX
+#pragma once
+#endif
+#ifndef _MPxHwShaderNode
+#define _MPxHwShaderNode
+//
+// *****************************************************************************
+//
+// Copyright (C) 1998-2001 Alias|Wavefront Inc.
+//
+// These coded instructions, statements and computer programs contain
+// unpublished information proprietary to Alias|Wavefront Inc. and are 
+// protected by Canadian and US federal copyright laws. They may not be 
+// disclosed to third parties or copied or duplicated, in whole or in part, 
+// without prior written consent of Alias|Wavefront Inc.
+//
+// Unpublished-rights reserved under the Copyright Laws of the United States.
+//
+// *****************************************************************************
+//
+// CLASS:    MPxHwShaderNode
+//
+// *****************************************************************************
+//
+// CLASS DESCRIPTION (MPxHwShaderNode)
+// 
+// MPxHwShaderNode allows the creation of user-defined hwShaders.  A hwShader
+// is a node which takes any number of input geometries, deforms them and
+// places the output into the output geometry attribute.
+//
+// For more information, please see the built-in documentation
+// in MPxHwShaderNode.cpp.
+//
+// *****************************************************************************
+
+#if defined __cplusplus
+
+// *****************************************************************************
+
+// INCLUDED HEADER FILES
+
+
+#include <maya/MStatus.h>
+#include <maya/MTypes.h>
+#include <maya/MObject.h>
+#include <maya/MPxNode.h>
+#include <maya/MDrawRequest.h>
+#include <maya/M3dView.h>
+
+
+// *****************************************************************************
+
+// DECLARATIONS
+
+
+// *****************************************************************************
+
+// CLASS DECLARATION (MPxHwShaderNode)
+
+/// Base class for user defined hardware shaders (OpenMayaUI)
+/**
+  Create user defined hardware shaders.
+*/
+#ifdef _WIN32
+#pragma warning(disable: 4522)
+#endif // _WIN32
+
+class OPENMAYAUI_EXPORT MPxHwShaderNode : public MPxNode  
+{
+public:
+	///
+	enum Writeable {
+		///
+		kWriteNone				= 0x0000,
+		///
+		kWriteVertexArray		= 0x0001,
+		///
+		kWriteNormalArray		= 0x0002,
+		///
+		kWriteColorArrays		= 0x0004,
+		///
+		kWriteTexCoordArrays	= 0x0008,
+		///
+		kWriteAll				= 0x000f
+	};
+
+    ///
+	MPxHwShaderNode();
+
+    ///
+	virtual ~MPxHwShaderNode();
+
+	///                     
+	virtual MPxNode::Type type() const;
+
+	// Methods to overload
+
+
+	// Override this method to set up the OpenGL state
+	//
+	///
+	virtual MStatus		bind( const MDrawRequest& request,
+							  M3dView& view );
+
+	// Override this method to return OpenGL to a sane state
+	//
+	///
+	virtual MStatus		unbind( const MDrawRequest& request,
+								M3dView& view );
+
+	// Override this method to actually draw primitives on the display
+	//
+	///
+	virtual MStatus		geometry( const MDrawRequest& request,
+								  M3dView& view,
+								  int prim,
+								  unsigned int writable,
+								  int indexCount,
+								  const unsigned int * indexArray,
+								  int vertexCount,
+								  const float * vertexArray,
+								  int normalCount,
+								  const float ** normalArrays,
+								  int colorCount,
+								  const float ** colorArrays,
+								  int texCoordCount,
+								  const float ** texCoordArrays);
+
+	// Override this method to specify how many "normals" per vertex
+	// the hardware shader would like.  Maya can provide from 0 to 3
+	// normals per vertex.  The second and third "normal" will be
+	// tangents.  If you do not override this method, Maya will
+	// provide 1 normal per vertex.
+	//
+	///
+	virtual	int		normalsPerVertex();
+
+	// Override this method to specify how many colors per vertex the
+	// hardware shader would like Maya to provide.  Maya may not provide
+	// this many if they are not available.  If you do not override
+	// this method, Maya will provide 0 colors per vertex.
+	//
+	///
+	virtual int		colorsPerVertex();
+
+	// Override this method to specifie how many texture coordinates
+	// per vertex the hardware shader would like Maya to provide.
+	// Maya may not provide this many if they are not available.  If
+	// you do not override this method, Maya will provide 0 texture
+	// coordinates per vertex.
+	//
+	///
+	virtual int		texCoordsPerVertex();
+
+	// Override this method to specify an array of names of uvSets
+	// that should be provided.  When Maya calls the geometry method,
+	// the uv values from the nth name in the list will be passed in
+	// the nth texCoordArray.
+	//
+	///
+	virtual int		getTexCoordSetNames(MStringArray& names);
+
+	// Specifies whether or not the hw shader uses transparency.  If
+	// so, the objects that use this shader must be drawn after all
+	// the opaque objects.
+	//
+	///
+	virtual bool	hasTransparency();
+
+	// Attributes inherited from surfaceShader
+	/// output color value
+	static MObject outColor;
+	/// output color red
+	static MObject outColorR;
+	/// output color green
+	static MObject outColorG;
+	/// output color blue
+	static MObject outColorB;
+
+	/// output transparency value
+	static MObject outTransparency;
+	/// output transparency red
+	static MObject outTransparencyR;
+	/// output transparency green
+	static MObject outTransparencyG;
+	/// output transparency blue
+	static MObject outTransparencyB;
+
+	/// output matte opacity value
+	static MObject outMatteOpacity;
+	/// output matte opacity red
+	static MObject outMatteOpacityR;
+	/// output matte opacity green
+	static MObject outMatteOpacityG;
+	/// output matte opacity blue
+	static MObject outMatteOpacityB;
+
+	/// output glow color value
+	static MObject outGlowColor;
+	/// output glow color red
+	static MObject outGlowColorR;
+	/// output glow color green
+	static MObject outGlowColorG;
+	/// output glow color blue
+	static MObject outGlowColorB;
+
+
+protected:
+// No protected members
+	  
+private:
+	static void				initialSetup();
+	static const char*	    className();
+
+
+
+};
+
+#ifdef _WIN32
+#pragma warning(default: 4522)
+#endif // _WIN32
+
+// *****************************************************************************
+#endif /* __cplusplus */
+#endif /* _MPxNode */