Emergency 2017 Dokumentation  v3.0.1
qsf::logic::SequenceTrackKeyEntityComponentPropertyColor3 Class Reference

#include <SequenceTrackEntityComponentPropertyColor3.h>

Public Member Functions

 SequenceTrackKeyEntityComponentPropertyColor3 (uint32 frameNumber)
 
- Public Member Functions inherited from qsf::logic::SequenceTrackKey
 SequenceTrackKey (uint32 frameNumber)
 
uint32 getFrameNumber () const
 Frame number is readonly; if you need to modify the time of a key, you have to remove and re-insert it into the track. More...
 
- Public Member Functions inherited from qsf::Object
virtual ~Object ()
 Destructor. More...
 
const camp::Class & getCampClass () const
 Return the CAMP class. More...
 
int getPropertyIndexById (const StringHash &propertyId) const
 Return the CAMP property index by using the unique class property ID. More...
 
uint32 getPropertyIdByIndex (int index) const
 Return the unique class property ID with the given index. More...
 
std::string getPropertyNameById (const StringHash &propertyId) const
 Return the CAMP property name by using the unique class property ID. More...
 
const camp::Property * getCampPropertyById (const StringHash &propertyId) const
 Return the CAMP property by using the unique class property ID. More...
 
void setPropertyValuesByString (const std::string &values)
 Set CAMP reflection property values by using a given string. More...
 
void setPropertiesToDefaultValues ()
 Set all CAMP reflection system properties to their default values. More...
 
void serializeToBoostPTree (boost::property_tree::ptree &pTree, SerializationMethod serializationMethod=SERIALIZE_DIFFERENTIAL) const
 
void serializeToBoostPTree (boost::property_tree::ptree &pTree, const camp::Class &campClass, SerializationMethod serializationMethod=SERIALIZE_DIFFERENTIAL) const
 
bool deserializeFromBoostPTree (const boost::property_tree::ptree &pTree, SerializationMethod serializationMethod=SERIALIZE_DIFFERENTIAL)
 
bool deserializeFromBoostPTree (const boost::property_tree::ptree &pTree, const camp::Class &campClass, SerializationMethod serializationMethod=SERIALIZE_DIFFERENTIAL)
 
void serializeToBinarySerializer (BinarySerializer &serializer, SerializationMode mode=MODE_MINIMAL, SerializationMethod serializationMethod=SERIALIZE_DIFFERENTIAL) const
 
void deserializeFromBinarySerializer (BinarySerializer &serializer, SerializationMode mode=MODE_MINIMAL, SerializationMethod serializationMethod=SERIALIZE_DIFFERENTIAL, bool setOverrideState=true)
 
virtual camp::Value getPropertyDefaultValue (const StringHash &propertyId) const
 
virtual PropertyOverrideState getPropertyOverrideState (const StringHash &propertyId) const
 
virtual bool setPropertyOverrideState (const StringHash &propertyId, PropertyOverrideState overrideState)
 
virtual void onPreDeserialize ()
 Called right before the object is deserialized using any of the above methods. Default implementation is empty. More...
 
virtual void onPostDeserialize ()
 Called right after the object was deserialized using any of the above methods. Default implementation is empty. More...
 
virtual ScriptgetAssociatedScript () const
 Return the script instance associated with this object instance. More...
 

Public Attributes

Color3 bezierControlPointIncomingValue
 See the class documentation for info about control point values. More...
 
glm::vec3 bezierControlPointIncomingTime
 See the class documentation for info about control point times. More...
 
Color3 value
 
Color3 bezierControlPointOutgoingValue
 See the class documentation for info about control point values. More...
 
glm::vec3 bezierControlPointOutgoingTime
 See the class documentation for info about control point times. More...
 
union {
   bool   bezierSplitTangents [3]
 
   struct {
      bool   bezierSplitTangentsR
 
      bool   bezierSplitTangentsG
 
      bool   bezierSplitTangentsB
 
   } 
 
}; 
 

Additional Inherited Members

- Public Types inherited from qsf::Object
enum  PropertyOverrideState { PROPERTY_INVALID, PROPERTY_DEFAULT, PROPERTY_OVERRIDE, PROPERTY_REMOVED }
 
enum  SerializationMethod { SERIALIZE_FLAT, SERIALIZE_COMPLETE, SERIALIZE_DIFFERENTIAL, SERIALIZE_IGNORE_UNKNOWN }
 
enum  SerializationMode { MODE_MINIMAL, MODE_COMPATIBLE }
 
- Static Public Member Functions inherited from qsf::logic::SequenceTrackKey
static bool compareKeyTimes (const SequenceTrackKey *a, const SequenceTrackKey *b)
 
static bool compareKeyWithTime (const SequenceTrackKey *a, const uint32 &b)
 
static bool compareTimeWithKey (const uint32 &a, const SequenceTrackKey *b)
 
- Protected Member Functions inherited from qsf::Object
 Object ()
 Default constructor. More...
 

Detailed Description

Todo:
-TODO(oi) Put key micro-classes into it own files??

Definition at line 38 of file SequenceTrackEntityComponentPropertyColor3.h.

Constructor & Destructor Documentation

qsf::logic::SequenceTrackKeyEntityComponentPropertyColor3::SequenceTrackKeyEntityComponentPropertyColor3 ( uint32  frameNumber)
inlineexplicit

Definition at line 78 of file SequenceTrackEntityComponentPropertyColor3.h.

Member Data Documentation

union { ... }
Remarks
Yeah, unions are a bit ugly, but we need two simple interfaces to the flag: a) A serializable representation (the 3 individual values) b) A indexible representation (mainly for the editor and speed-of-access) And unions make this pretty easy on fixed-size data
glm::vec3 qsf::logic::SequenceTrackKeyEntityComponentPropertyColor3::bezierControlPointIncomingTime

See the class documentation for info about control point times.

Definition at line 47 of file SequenceTrackEntityComponentPropertyColor3.h.

Color3 qsf::logic::SequenceTrackKeyEntityComponentPropertyColor3::bezierControlPointIncomingValue

See the class documentation for info about control point values.

Definition at line 46 of file SequenceTrackEntityComponentPropertyColor3.h.

glm::vec3 qsf::logic::SequenceTrackKeyEntityComponentPropertyColor3::bezierControlPointOutgoingTime

See the class documentation for info about control point times.

Definition at line 50 of file SequenceTrackEntityComponentPropertyColor3.h.

Color3 qsf::logic::SequenceTrackKeyEntityComponentPropertyColor3::bezierControlPointOutgoingValue

See the class documentation for info about control point values.

Definition at line 49 of file SequenceTrackEntityComponentPropertyColor3.h.

bool qsf::logic::SequenceTrackKeyEntityComponentPropertyColor3::bezierSplitTangents[3]

Definition at line 62 of file SequenceTrackEntityComponentPropertyColor3.h.

bool qsf::logic::SequenceTrackKeyEntityComponentPropertyColor3::bezierSplitTangentsB

Definition at line 69 of file SequenceTrackEntityComponentPropertyColor3.h.

bool qsf::logic::SequenceTrackKeyEntityComponentPropertyColor3::bezierSplitTangentsG

Definition at line 68 of file SequenceTrackEntityComponentPropertyColor3.h.

bool qsf::logic::SequenceTrackKeyEntityComponentPropertyColor3::bezierSplitTangentsR

Definition at line 67 of file SequenceTrackEntityComponentPropertyColor3.h.

Color3 qsf::logic::SequenceTrackKeyEntityComponentPropertyColor3::value

Definition at line 48 of file SequenceTrackEntityComponentPropertyColor3.h.


The documentation for this class was generated from the following file: