Emergency 2017 Dokumentation  v3.0.1
qsf::PolygonComponent Class Reference

Polygon component class. More...

#include <PolygonComponent.h>

Public Member Functions

 PolygonComponent (Prototype *prototype)
 Constructor. More...
 
virtual ~PolygonComponent ()
 Destructor. More...
 
float getHeight () const
 Return the height of the polygon. More...
 
void setHeight (float height)
 Set the height of the polygon. More...
 
bool isPositionInside (const glm::vec3 &worldPosition, bool perform3dTest=false) const
 "true" if the tested position is inside the polygon; test is only 2d, until stated otherwise More...
 
float getDistanceToClosestLine (const glm::vec3 &worldPosition, bool allowInnerDistance=false, glm::vec3 *nearestPointOnPoly=nullptr) const
 Return the closed polygon distance by using a given world space position. More...
 
void getComplex2DPolygon (Complex2DPolygon &outPolygon) const
 Fills out a Complex2DPolygon structure with the information from this polygon. More...
 
void buildCollisionMeshIfNecessary (bool isStartup)
 Internal helper method to create a fitting collision mesh for this polygon. More...
 
void buildCollisionMeshIfNecessary (bool isStartup, BulletTriangleMeshCollisionComponent &bulletTriangleMeshCollisionComponent)
 
virtual uint32 getMiniumNumberOfNodes () const override
 Return the minimum number of nodes the concrete nodes component instance needs to be valid. More...
 
virtual void setNode (std::size_t index, const Node &value) override
 
virtual void setNodeToPosition (uint32 nodeIndex, const glm::vec3 &newPosition) override
 
virtual void addPosition (const glm::vec3 &position) override
 Add a position to all nodes. More...
 
virtual void setNodes (const std::vector< Node > &nodes) override
 
virtual void setDebug (bool debugMode) override
 Set whether or not the component is considered to be in debug mode. More...
 
virtual void onComponentTransformChange (const Transform &transform, TransformChangeFlags flags) override
 Called in case a component transformation value was changed. More...
 
virtual void serialize (BinarySerializer &serializer) override
 Serialize or deserialize the component using a binary serializer. More...
 
- Public Member Functions inherited from qsf::NodesComponent
 NodesComponent (Prototype *prototype)
 Constructor. More...
 
virtual ~NodesComponent ()
 Destructor. More...
 
const DebugFlagSetgetDebugFlagSet () const
 Return the debug flag set. More...
 
void setDebugFlagSet (const DebugFlagSet &debugFlagSet)
 Set the debug flag set. More...
 
glm::vec3 calculateCenterPosition () const
 Calculate the center position of the nodes. More...
 
bool hitNodeWithRay (const Ray &ray, int &nodeIndex) const
 Checks if the given ray is hitting a node. More...
 
int getClosestSegmentIndexToPoint (const glm::vec3 &point, glm::vec3 *closestPoint=nullptr) const
 Return the closed segment of the nodes from the given point. More...
 
uint32 getNumberOfNodes () const
 Return the number of nodes. More...
 
void createNodeGeometryOnNode (uint32 nodeIndex, const Color4 &color, float boxRadius=0.5f, DebugDrawProxy *debugDrawProxy=nullptr, bool doInitialization=false)
 Creates a visual box (looking like a bounding box) around the given node. More...
 
virtual void insertNode (std::size_t before, const Node &value)
 
virtual void removeNode (std::size_t index)
 
virtual void setNodeToTransform (uint32 nodeIndex, const Transform &newTransform)
 Changes the transform of a node and propagates the property change. More...
 
virtual const std::vector< Node > & getNodes () const
 
- Public Member Functions inherited from qsf::Component
virtual ~Component ()
 Destructor. More...
 
PrototypegetPrototype () const
 Return the prototype this component is in. More...
 
EntitygetEntity () const
 Return a reference to the entity this component is in. More...
 
uint32 getId () const
 Return the unique component identifier. More...
 
ComponentManagergetComponentManager () const
 Return the component manager that's responsible for this component instance. More...
 
ComponentCollectiongetComponentCollection () const
 Return the component collection that's responsible for this component instance. More...
 
bool isSimulating () const
 Return whether or not the component is in simulating mode. More...
 
bool isActive () const
 Return whether or not the component is considered to be active. More...
 
void setActive (bool active)
 Set whether or not the component is considered to be active. More...
 
bool isDebug () const
 Return whether or not the component is considered to be in debug mode. More...
 
bool isHidden () const
 Return whether or not the component is hidden. More...
 
void setHidden (bool hidden)
 Set whether or not the component is hidden. More...
 
bool isGloballyHidden () const
 Return whether or not the component is globally hidden. More...
 
void setGloballyHidden (bool globallyHidden)
 Set whether or not the component is globally hidden. More...
 
bool isReallyHidden () const
 Return whether or not the component is really hidden. More...
 
bool startup ()
 Startup the component. More...
 
bool isRunning () const
 Return whether or not the component is up-and-running. More...
 
void shutdown ()
 Shutdown the component. More...
 
uint64 getPrototypeId () const
 Return the ID of the prototype this component is in. More...
 
uint64 getEntityId () const
 Return the ID of the entity this component is in. More...
 
virtual void onInvalidation ()
 Invalidate the component. More...
 
- Public Member Functions inherited from qsf::InheritedObject
void copyPropertyOverrideStateFrom (const InheritedObject &object, bool add=false)
 
void setAllPropertyOverrideFlags (bool value)
 
void autoCreatePropertyOverrideState ()
 
virtual camp::Value getPropertyDefaultValue (const StringHash &propertyId) const override
 
virtual PropertyOverrideState getPropertyOverrideState (const StringHash &propertyId) const override
 
virtual bool setPropertyOverrideState (const StringHash &propertyId, PropertyOverrideState overrideState) override
 
- 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 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...
 

Static Public Attributes

static const uint32 COMPONENT_ID
 "qsf::PolygonComponent" unique component ID More...
 
static const uint32 HEIGHT
 "Height" unique class property ID inside the class More...
 
- Static Public Attributes inherited from qsf::NodesComponent
static const uint32 COMPONENT_ID
 "qsf::NodesComponent" unique component ID More...
 
static const uint32 NODES
 "Nodes" unique class property ID inside the class More...
 
- Static Public Attributes inherited from qsf::Component
static const uint32 COMPONENT_ID
 "qsf::Component" unique component ID More...
 

Protected Member Functions

virtual bool onStartup () override
 Startup the component. More...
 
virtual bool closedContinuousLines () const override
 Return whether or not closed continuous lines are used. More...
 
virtual void startDebugDrawing () override
 Start debug visualization. More...
 
virtual const Color4getPolygonDebugColor () const
 
- Protected Member Functions inherited from qsf::NodesComponent
virtual void onSetDebugFlagSet ()
 Called if there's a debug flag set change. More...
 
virtual void onUpdateNodes ()
 
virtual bool implementsOnComponentPropertyChange () const override
 Signal whether this component needs the "onComponentPropertyChange" callback at all. More...
 
virtual void onComponentPropertyChange (const Component &component, uint32 propertyId) override
 Called in case a component property value was changed. More...
 
virtual void onSetDebug (bool debug) override
 Set whether or not the component is considered to be in debug mode. More...
 
void cancelDebugDrawing ()
 
 QSF_CAMP_RTTI () QSF_CAMP_ARRAY_PROPERTY(Nodes
 
- Protected Member Functions inherited from qsf::Component
 Component (Prototype *prototype)
 Constructor. More...
 
void promotePropertyChange (uint32 propertyId)
 A component property value was changed. More...
 
template<typename T , typename S >
bool assignAndPromoteChange (T &variable, const S &newValue, uint32 propertyId)
 Comfort function for updating an exported member variable and promoting any change that happened. More...
 
void setRegisterForSimulationTransformChanges (bool enable)
 Register or unregister this component as simulation transform listener. More...
 
void setRegisterForAnimationTransformChanges (bool enable)
 Register or unregister this component as animation transform listener. More...
 
virtual const ObjectgetPropertyDefaultsProvider () const override
 
virtual void onSetSimulating (bool simulating)
 Set whether or not the component is in simulating mode. More...
 
virtual void onSetActive (bool active)
 Set whether or not the component is considered to be active. More...
 
virtual void onSetHidden (bool hidden)
 Set whether or not the component is considered to be hidden. More...
 
virtual void onShutdown ()
 Shutdown the component. More...
 
- Protected Member Functions inherited from qsf::InheritedObject
 InheritedObject ()
 Default constructor. More...
 
- Protected Member Functions inherited from qsf::Object
 Object ()
 Default constructor. More...
 
- Protected Member Functions inherited from qsf::WeakPtrTarget
 WeakPtrTarget ()
 Default constructor. More...
 
 WeakPtrTarget (const WeakPtrTarget &other)
 Copy constructor. More...
 
 WeakPtrTarget (WeakPtrTarget &&)=delete
 Delete the move constructor, as WeakPtrTarget would need a proper move constructor-implementation that ensures that its pointer gets updated in the WeakPtrBase as well. More...
 
 ~WeakPtrTarget ()
 Destructor. More...
 
void invalidateAllWeakPtr ()
 Invalidate all weak pointers to this object. More...
 
void operator= (const WeakPtrTarget &other)
 Copy operator. More...
 

Additional Inherited Members

- Public Types inherited from qsf::NodesComponent
enum  DebugFlags {
  DEBUG_NODES = 1<<0, DEBUG_NODES_ID = 1<<1, DEBUG_CENTER = 1<<2, DEBUG_EDGES = 1<<3,
  DEBUG_GATEWAYS = 1<<4, DEBUG_POLYGON = 1<<5
}
 Debug flags. More...
 
typedef BitFlagSet< uint8, DebugFlagsDebugFlagSet
 
- Public Types inherited from qsf::Component
enum  TransformChangeFlag {
  TRANSFORM_CHANGE_POSITION = 0x01, TRANSFORM_CHANGE_ROTATION = 0x02, TRANSFORM_CHANGE_SCALE = 0x04, TRANSFORM_CHANGE_TRANSFORM = 0x07,
  TRANSFORM_CHANGE_FOR_SIMULATION = 0x08, TRANSFORM_CHANGE_FOR_ANIMATION = 0x10
}
 
typedef BitFlagSet< uint8, TransformChangeFlagTransformChangeFlags
 
- 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 }
 
- Protected Attributes inherited from qsf::NodesComponent
std::vector< NodemNodes
 The local space nodes. More...
 
DebugFlagSet mDebugFlagSet
 Debug flag set. More...
 
DebugDrawProxy mDebugDrawProxy
 Debug draw proxy for visualization. More...
 
 NodesComponent
 
- Protected Attributes inherited from qsf::InheritedObject
std::bitset< 128 > mPropertyOverrideFlags
 One bit for each property; if set, the property is overridden. More...
 

Detailed Description

Polygon component class.

Todo:
  • TODO(co) Please note that in here, the term "polygon" is not used as it is used normally in mathematics and computer graphics. As a graphics programmer I'm not really happy that we misuse the name "polygon" in here which will probably confuse people outside the company. Something like "PolygonVolumeComponent", "AmbientVolumeComponent" etc. would make much more sense.

Definition at line 44 of file PolygonComponent.h.

Constructor & Destructor Documentation

qsf::PolygonComponent::PolygonComponent ( Prototype prototype)
inline

Constructor.

Parameters
[in]prototypeThe prototype this component is in, no null pointer allowed

Definition at line 14 of file PolygonComponent-inl.h.

qsf::PolygonComponent::~PolygonComponent ( )
inlinevirtual

Destructor.

Definition at line 21 of file PolygonComponent-inl.h.

Member Function Documentation

virtual void qsf::PolygonComponent::addPosition ( const glm::vec3 &  position)
overridevirtual

Add a position to all nodes.

Parameters
[in]positionThe local space position to add

Reimplemented from qsf::NodesComponent.

void qsf::PolygonComponent::buildCollisionMeshIfNecessary ( bool  isStartup)

Internal helper method to create a fitting collision mesh for this polygon.

void qsf::PolygonComponent::buildCollisionMeshIfNecessary ( bool  isStartup,
BulletTriangleMeshCollisionComponent bulletTriangleMeshCollisionComponent 
)
bool qsf::PolygonComponent::closedContinuousLines ( ) const
inlineoverrideprotectedvirtual

Return whether or not closed continuous lines are used.

Note
  • This information is relevant for e.g. "qsf::NodesComponent::getClosestSegmentIndexToPoint()"
  • While a simple path usually does not form a circle (segment from end to start node), a polygon is usually closed

Implements qsf::NodesComponent.

Reimplemented in qsf::LiquidPolygonComponent.

Definition at line 35 of file PolygonComponent-inl.h.

void qsf::PolygonComponent::getComplex2DPolygon ( Complex2DPolygon outPolygon) const

Fills out a Complex2DPolygon structure with the information from this polygon.

float qsf::PolygonComponent::getDistanceToClosestLine ( const glm::vec3 &  worldPosition,
bool  allowInnerDistance = false,
glm::vec3 *  nearestPointOnPoly = nullptr 
) const

Return the closed polygon distance by using a given world space position.

float qsf::PolygonComponent::getHeight ( ) const
inline

Return the height of the polygon.

Note
  • Connected to the CAMP reflection system

Definition at line 26 of file PolygonComponent-inl.h.

virtual uint32 qsf::PolygonComponent::getMiniumNumberOfNodes ( ) const
overridevirtual

Return the minimum number of nodes the concrete nodes component instance needs to be valid.

Returns
The minimum number of nodes the concrete nodes component instance needs to be valid

Reimplemented from qsf::NodesComponent.

bool qsf::PolygonComponent::isPositionInside ( const glm::vec3 &  worldPosition,
bool  perform3dTest = false 
) const

"true" if the tested position is inside the polygon; test is only 2d, until stated otherwise

virtual void qsf::PolygonComponent::onComponentTransformChange ( const Transform transform,
TransformChangeFlags  flags 
)
overridevirtual

Called in case a component transformation value was changed.

Parameters
[in]transformThe changed transformation
[in]flagsFlags describing the change
Note
  • The default implementation is empty
  • In order for this to get called at all in simulating mode, an entity has to register itself as listener for simulation and/or animation transform changes, see e.g. "qsf::Component::setRegisterForSimulationTransformChanges".

Reimplemented from qsf::Component.

virtual bool qsf::PolygonComponent::onStartup ( )
overrideprotectedvirtual

Startup the component.

Returns
"true" if all went fine, else "false"
Note
  • The default implementation is empty
  • Only components which are part of entities (concrete prototype instances) get started
  • When this method gets called, the properties might still be on default values but it's also possible that properties already have customized values. Take this into account when implementing your method.

Reimplemented from qsf::Component.

Reimplemented in qsf::AmbientPolygonComponent, qsf::GroundTypePolygonComponent, qsf::LiquidPolygonComponent, and em5::WaterDeepTypePolygonComponent.

virtual void qsf::PolygonComponent::serialize ( BinarySerializer serializer)
overridevirtual

Serialize or deserialize the component using a binary serializer.

Parameters
[in]serializerThe serializer, which can be either in read or write mode

Reimplemented from qsf::NodesComponent.

virtual void qsf::PolygonComponent::setDebug ( bool  debugMode)
overridevirtual

Set whether or not the component is considered to be in debug mode.

Parameters
[in]debugMode"true" if the component is considered to be in debug mode, else "false"
Remarks
The semantic of "debug mode" depends of the component. An implementation is free to ignore the request or do nothing at all because a debug mode state makes no sense for the component. A polygon component might for example interpret "debug mode" as "render the polygons" while an input component might interpret "debug mode" as "draw some texts".
Note
  • Not connected to the CAMP reflection system by intent, this should be internal only

Reimplemented from qsf::Component.

void qsf::PolygonComponent::setHeight ( float  height)

Set the height of the polygon.

Note
  • Connected to the CAMP reflection system
virtual void qsf::PolygonComponent::setNode ( std::size_t  index,
const Node value 
)
overridevirtual

Reimplemented from qsf::NodesComponent.

virtual void qsf::PolygonComponent::setNodes ( const std::vector< Node > &  nodes)
overridevirtual

Reimplemented from qsf::NodesComponent.

virtual void qsf::PolygonComponent::setNodeToPosition ( uint32  nodeIndex,
const glm::vec3 &  newPosition 
)
overridevirtual

Reimplemented from qsf::NodesComponent.

virtual void qsf::PolygonComponent::startDebugDrawing ( )
overrideprotectedvirtual

Start debug visualization.

Reimplemented from qsf::NodesComponent.

Member Data Documentation

const uint32 qsf::PolygonComponent::COMPONENT_ID
static

"qsf::PolygonComponent" unique component ID

Definition at line 52 of file PolygonComponent.h.

const uint32 qsf::PolygonComponent::HEIGHT
static

"Height" unique class property ID inside the class

Definition at line 53 of file PolygonComponent.h.


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