imagePlane.h

Go to the documentation of this file.
00001 //**************************************************************************/
00002 // Copyright (c) 2008 Autodesk, Inc.
00003 // All rights reserved.
00004 //
00005 // Use of this software is subject to the terms of the Autodesk license
00006 // agreement provided at the time of installation or download, or which
00007 // otherwise accompanies this software in either electronic or hard copy form.
00008 //
00009 //**************************************************************************/
00010 // DESCRIPTION:
00011 // CREATED: September 2009
00012 //**************************************************************************/
00013 
00014 #if !defined IMAGE_PLANE_H_
00015 #define IMAGE_PLANE_H_
00016 
00017 namespace mudbox {
00018 
00019 class MBDLL_DECL ImagePlaneInterface: public Node
00020 {
00021     DECLARE_CLASS;
00022 
00023 public:
00024     mudbox::Matrix TMatrix() const;             // returns the current matrix of the image plane
00025 
00026     mudbox::Image *Image() const;               // returns the image data used by the plane to sample from
00027 
00028     float Depth() const;                        // returns the depth of the image plane
00029 
00030     bool Visible( void ) const ;                // check if the image plane is displayed at all
00031 
00032     mudbox::Matrix ImageToScreenMatrix() const; // returns the transformation matrix from image plane local coordinate to screen coordinate
00033 
00034 };
00035 
00036 
00037 
00038 //-
00039 // ==================================================================
00040 // (C) Copyright 2009 by Autodesk, Inc. All Rights Reserved. By using
00041 // this code,  you  are  agreeing  to the terms and conditions of the
00042 // License  Agreement  included  in  the documentation for this code.
00043 // AUTODESK  MAKES  NO  WARRANTIES,  EXPRESS  OR  IMPLIED,  AS TO THE
00044 // CORRECTNESS OF THIS CODE OR ANY DERIVATIVE WORKS WHICH INCORPORATE
00045 // IT.  AUTODESK PROVIDES THE CODE ON AN 'AS-IS' BASIS AND EXPLICITLY
00046 // DISCLAIMS  ANY  LIABILITY,  INCLUDING CONSEQUENTIAL AND INCIDENTAL
00047 // DAMAGES  FOR ERRORS, OMISSIONS, AND  OTHER  PROBLEMS IN THE  CODE.
00048 //
00049 // Use, duplication,  or disclosure by the U.S. Government is subject
00050 // to  restrictions  set forth  in FAR 52.227-19 (Commercial Computer
00051 // Software Restricted Rights) as well as DFAR 252.227-7013(c)(1)(ii)
00052 // (Rights  in Technical Data and Computer Software),  as applicable.
00053 // ==================================================================
00054 //+
00055 
00056 #endif
00057 //------------------------------------------------------------------------------
00058 
00059 }; // end of namespace mudbox
00060