← Back to branch summary

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

« back to all changes in this revision

Viewing changes to COLLADAFramework/include/COLLADAFWAnnotate.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/COLLADAFWAnnotate.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_ANNOTATE_H__
 
12
#define __COLLADAFW_ANNOTATE_H__
 
13
 
 
14
#include "COLLADAFWPrerequisites.h"
 
15
#include "COLLADAFWValueType.h"
 
16
 
 
17
 
 
18
namespace COLLADAFW
 
19
{
 
20
 
 
21
    /** 
 
22
    Adds a strongly typed annotation remark to the parent object.
 
23
    
 
24
    Annotations represent objects of the form SYMBOL = VALUE, where SYMBOL is a user-defined 
 
25
    identifier and VALUE is a strongly typed value. Annotations communicate metainformation from 
 
26
    the Effect Runtime to the application only and are not interpreted by the COLLADA document.
 
27
    */
 
28
        class Annotate  
 
29
    {
 
30
        private:
 
31
        
 
32
        /** The text string name of this element that represents the SYMBOL in an object of
 
33
        the form SYMBOL = VALUE. Required. */
 
34
        String mName;
 
35
 
 
36
        /** A strongly typed value that represents the VALUE in an object of the form 
 
37
        SYMBOL = VALUE. Consists of a COLLADA type element that contains a value of that type. 
 
38
        Valid type elements are:
 
39
        bool, bool2, bool3, bool4, 
 
40
        int, int2, int3, int4, 
 
41
        float, float2, float3, float4, 
 
42
        float2x2, float3x3, float4x4, 
 
43
        string */
 
44
        ValueType mValue;
 
45
 
 
46
        public:
 
47
 
 
48
        /** Constructor. */
 
49
                Annotate();
 
50
 
 
51
        /** Destructor. */
 
52
                virtual ~Annotate();
 
53
 
 
54
        /** The text string name of this element that represents the SYMBOL in an object of
 
55
        the form SYMBOL = VALUE. Required. */
 
56
        const String getName () const { return mName; }
 
57
 
 
58
        /** The text string name of this element that represents the SYMBOL in an object of
 
59
        the form SYMBOL = VALUE. Required. */
 
60
        void setName ( const String Name ) { mName = Name; }
 
61
 
 
62
        /** A strongly typed value that represents the VALUE in an object of the form 
 
63
        SYMBOL = VALUE. Consists of a COLLADA type element that contains a value of that type. 
 
64
        Valid type elements are:
 
65
        bool, bool2, bool3, bool4, 
 
66
        int, int2, int3, int4, 
 
67
        float, float2, float3, float4, 
 
68
        float2x2, float3x3, float4x4, 
 
69
        string */
 
70
        const ValueType getValue () const { return mValue; }
 
71
 
 
72
        /** A strongly typed value that represents the VALUE in an object of the form 
 
73
        SYMBOL = VALUE. Consists of a COLLADA type element that contains a value of that type. 
 
74
        Valid type elements are:
 
75
        bool, bool2, bool3, bool4, 
 
76
        int, int2, int3, int4, 
 
77
        float, float2, float3, float4, 
 
78
        float2x2, float3x3, float4x4, 
 
79
        string */
 
80
        void setValue ( const ValueType Value ) { mValue = Value; }
 
81
 
 
82
        private:
 
83
 
 
84
        /** Disable default copy ctor. */
 
85
                Annotate( const Annotate& pre );
 
86
 
 
87
        /** Disable default assignment operator. */
 
88
                const Annotate& operator= ( const Annotate& pre );
 
89
 
 
90
        };
 
91
 
 
92
} // namespace COLLADAFW
 
93
 
 
94
#endif // __COLLADAFW_ANNOTATE_H__