← Back to branch summary

~ubuntu-branches/ubuntu/wily/opencollada/wily-proposed

« back to all changes in this revision

Viewing changes to COLLADAFramework/include/COLLADAFWSemantic.h

  • Committer: Package Import Robot
  • Author(s): Matteo F. Vescovi
  • Date: 2015-05-14 17:23:27 UTC
  • Revision ID: package-import@ubuntu.com-20150514172327-f862u8envms01fra
Tags: upstream-0.1.0~20140703.ddf8f47+dfsg1
Import upstream version 0.1.0~20140703.ddf8f47+dfsg1

Show diffs side-by-side

added added

removed removed

Lines of Context:
COLLADAFramework/include/COLLADAFWSemantic.h
 
1
/*
 
2
    Copyright (c) 2008-2009 NetAllied Systems GmbH
 
3
 
 
4
    This file is part of COLLADAFramework.
 
5
 
 
6
    Licensed under the MIT Open Source License, 
 
7
    for details please see LICENSE file or the website
 
8
    http://www.opensource.org/licenses/mit-license.php
 
9
*/
 
10
 
 
11
#ifndef __COLLADAFW_SEMANTIC_H__
 
12
#define __COLLADAFW_SEMANTIC_H__
 
13
 
 
14
#include "COLLADAFWPrerequisites.h"
 
15
 
 
16
 
 
17
namespace COLLADAFW
 
18
{
 
19
 
 
20
    /** 
 
21
    Provides metainformation that describes the purpose of a parameter declaration.
 
22
    
 
23
    Semantics describe the intention or purpose of a parameter declaration in an effect, using an 
 
24
    overloaded concept. Semantics have been used historically to describe three different type of 
 
25
    metainformation:
 
26
    � A hardware resource allocated to a parameter, for example, TEXCOORD2, NORMAL.
 
27
    � A value from the scene graph or graphics API that is being represented by this parameter, for
 
28
    example, MODELVIEWMATRIX, CAMERAPOS, VIEWPORTSIZE.
 
29
    � A user-defined value that will be set by the application at run time when the effect is being 
 
30
    initialized, for example, DAMAGE_PERCENT, MAGIC_LEVEL.
 
31
    Semantics are used by the <instance_geometry> declaration inside <node> to bind effect 
 
32
    parameters to values and data sources that can be found in the scene graph, using the 
 
33
    <bind_material> mechanism used to disambiguate this mapping.
 
34
    */
 
35
        class Semantic  
 
36
    {
 
37
        private:
 
38
        
 
39
        /** There is currently no standard set of semantics. This element can contain any 
 
40
        xs:NCName defined by your application. */
 
41
        String mValue;
 
42
 
 
43
        public:
 
44
 
 
45
        /** Constructor. */
 
46
        Semantic() {}
 
47
 
 
48
        /** Destructor. */
 
49
        virtual ~Semantic() {}
 
50
 
 
51
        /** There is currently no standard set of semantics. This element can contain any 
 
52
        xs:NCName defined by your application. */
 
53
        const String getValue () const { return mValue; }
 
54
 
 
55
        /** There is currently no standard set of semantics. This element can contain any 
 
56
        xs:NCName defined by your application. */
 
57
        void setValue ( const String Value ) { mValue = Value; }
 
58
 
 
59
        private:
 
60
 
 
61
        /** Disable default copy ctor. */
 
62
                Semantic( const Semantic& pre );
 
63
 
 
64
        /** Disable default assignment operator. */
 
65
                const Semantic& operator= ( const Semantic& pre );
 
66
 
 
67
        };
 
68
 
 
69
} // namespace COLLADAFW
 
70
 
 
71
#endif // __COLLADAFW_SEMANTIC_H__