Panda3D
logicOpAttrib.h
1 /**
2  * PANDA 3D SOFTWARE
3  * Copyright (c) Carnegie Mellon University. All rights reserved.
4  *
5  * All use of this software is subject to the terms of the revised BSD
6  * license. You should have received a copy of this license along
7  * with this source code in a file named "LICENSE."
8  *
9  * @file logicOpAttrib.I
10  * @author rdb
11  * @date 2016-03-24
12  */
13 
14 #ifndef LOGICOPATTRIB_H
15 #define LOGICOPATTRIB_H
16 
17 #include "pandabase.h"
18 #include "luse.h"
19 #include "renderAttrib.h"
20 
21 class FactoryParams;
22 
23 /**
24  * If enabled, specifies that a custom logical operation be performed instead
25  * of any color blending. Setting it to a value other than M_none will cause
26  * color blending to be disabled and the given logic operation to be performed.
27  */
28 class EXPCL_PANDA_PGRAPH LogicOpAttrib : public RenderAttrib {
29 PUBLISHED:
30  enum Operation {
31  O_none, // LogicOp disabled, regular blending occurs.
32  O_clear, // Clears framebuffer value.
33  O_and,
34  O_and_reverse,
35  O_copy, // Writes the incoming color to the framebuffer.
36  O_and_inverted,
37  O_noop, // Leaves the framebuffer value unaltered.
38  O_xor,
39  O_or,
40  O_nor,
41  O_equivalent,
42  O_invert,
43  O_or_reverse,
44  O_copy_inverted,
45  O_or_inverted,
46  O_nand,
47  O_set, // Sets all the bits in the framebuffer to 1.
48  };
49 
50 private:
51  INLINE LogicOpAttrib(Operation op);
52 
53 PUBLISHED:
54  static CPT(RenderAttrib) make_off();
55  static CPT(RenderAttrib) make(Operation op);
56  static CPT(RenderAttrib) make_default();
57 
58  INLINE Operation get_operation() const;
59  MAKE_PROPERTY(operation, get_operation);
60 
61 public:
62  virtual void output(std::ostream &out) const;
63 
64 protected:
65  virtual int compare_to_impl(const RenderAttrib *other) const;
66  virtual size_t get_hash_impl() const;
67 
68 private:
69  Operation _op;
70 
71 PUBLISHED:
72  static int get_class_slot() {
73  return _attrib_slot;
74  }
75  virtual int get_slot() const {
76  return get_class_slot();
77  }
78  MAKE_PROPERTY(class_slot, get_class_slot);
79 
80 public:
81  static void register_with_read_factory();
82  virtual void write_datagram(BamWriter *manager, Datagram &dg);
83 
84 protected:
85  static TypedWritable *make_from_bam(const FactoryParams &params);
86  void fillin(DatagramIterator &scan, BamReader *manager);
87 
88 public:
89  static TypeHandle get_class_type() {
90  return _type_handle;
91  }
92  static void init_type() {
93  RenderAttrib::init_type();
94  register_type(_type_handle, "LogicOpAttrib",
95  RenderAttrib::get_class_type());
96  _attrib_slot = register_slot(_type_handle, 100, new LogicOpAttrib(O_none));
97  }
98  virtual TypeHandle get_type() const {
99  return get_class_type();
100  }
101  virtual TypeHandle force_init_type() {init_type(); return get_class_type();}
102 
103 private:
104  static TypeHandle _type_handle;
105  static int _attrib_slot;
106 };
107 
108 EXPCL_PANDA_PGRAPH std::ostream &operator << (std::ostream &out, LogicOpAttrib::Operation op);
109 
110 #include "logicOpAttrib.I"
111 
112 #endif
This is the base class for a number of render attributes (other than transform) that may be set on sc...
Definition: renderAttrib.h:51
This is the fundamental interface for extracting binary objects from a Bam file, as generated by a Ba...
Definition: bamReader.h:110
PANDA 3D SOFTWARE Copyright (c) Carnegie Mellon University.
Base class for objects that can be written to and read from Bam files.
Definition: typedWritable.h:35
void register_type(TypeHandle &type_handle, const std::string &name)
This inline function is just a convenient way to call TypeRegistry::register_type(), along with zero to four record_derivation()s.
Definition: register_type.I:22
PANDA 3D SOFTWARE Copyright (c) Carnegie Mellon University.
This is the fundamental interface for writing binary objects to a Bam file, to be extracted later by ...
Definition: bamWriter.h:63
PANDA 3D SOFTWARE Copyright (c) Carnegie Mellon University.
virtual void write_datagram(BamWriter *manager, Datagram &dg)
Writes the contents of this object to the datagram for shipping out to a Bam file.
static int register_slot(TypeHandle type_handle, int sort, RenderAttrib *default_attrib)
Adds the indicated TypeHandle to the registry, if it is not there already, and returns a unique slot ...
Definition: renderAttrib.I:101
An instance of this class is passed to the Factory when requesting it to do its business and construc...
Definition: factoryParams.h:36
PANDA 3D SOFTWARE Copyright (c) Carnegie Mellon University.
If enabled, specifies that a custom logical operation be performed instead of any color blending...
Definition: logicOpAttrib.h:28
A class to retrieve the individual data elements previously stored in a Datagram. ...
TypeHandle is the identifier used to differentiate C++ class types.
Definition: typeHandle.h:81
An ordered list of data elements, formatted in memory for transmission over a socket or writing to a ...
Definition: datagram.h:38