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

Street section component class. More...

#include <StreetSectionComponent.h>

Public Member Functions

 StreetSectionComponent (Prototype *prototype)
 Constructor. More...
 
virtual ~StreetSectionComponent ()
 Destructor. More...
 
float getLength () const
 Return the length from first point till last point. More...
 
const AssetProxygetBaseMesh () const
 Return the base mesh asset to use. More...
 
void setBaseMesh (const AssetProxy &baseMesh)
 Set the base mesh asset to use. More...
 
bool getFlipXAxis () const
 Return whether or not the x axis should be flipped. More...
 
void setFlipXAxis (bool flipXAxis)
 Set whether or not the x axis should be flipped. More...
 
bool getFlipYAxis () const
 Return whether or not the y axis should be flipped. More...
 
void setFlipYAxis (bool flipYAxis)
 Set whether or not the y axis should be flipped. More...
 
float getBlendOutLengthAtStart () const
 Return the length of the blend out at the start of the path. More...
 
void setBlendOutLengthAtStart (float blendOutLengthAtStart)
 Set how long the blend out is at the start of the path. More...
 
float getBlendOutLengthAtEnd () const
 Return the length of the blend out at the end of the path. More...
 
void setBlendOutLengthAtEnd (float blendOutLengthAtEnd)
 Set how long the blend out is at the end of the path. More...
 
void dirtyMesh ()
 Mark the procedural street mesh to be dirty. More...
 
const StreetGatewayLinkgetBeginStreetGatewayLink () const
 Return the street gateway begin link. More...
 
const StreetGatewayLinkgetEndStreetGatewayLink () const
 Return the street gateway end link. More...
 
void calculateDerivedNodePositions (std::vector< glm::vec3 > &derivedNodes, int segmentsMin, int segmentsMax) const
 Calculate the derived node positions. More...
 
void snapTierNodeToPositionDirection (uint32 tierNodeIndex, const glm::vec3 &localSpacePosition, const glm::vec3 &localSpaceDirection)
 Snap the given tier node to the given position. More...
 
virtual glm::vec3 getStreetGatewayPosition (uint32 streetGatewayIndex) const override
 Get position of a street gateway with specified index. More...
 
virtual glm::vec3 getStreetGatewayDirection (uint32 streetGatewayIndex) const override
 Get direction of a street gateway with specified index. More...
 
virtual void serialize (BinarySerializer &serializer) override
 Serialize or deserialize the component using a binary serializer. 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
 
- Public Member Functions inherited from qsf::StreetComponent
 StreetComponent (Prototype *prototype)
 Constructor. More...
 
virtual ~StreetComponent ()
 Destructor. More...
 
const std::vector< StreetGateway > & getStreetGateways () const
 
glm::vec3 getStreetGatewayPositionInWorldSpace (uint32 streetGatewayIndex) const
 Get position of a street gateway with specified index in world space. More...
 
glm::vec3 getStreetGatewayDirectionInWorldSpace (uint32 streetGatewayIndex) const
 Get direction of a street gateway with specified index in world space. More...
 
StreetGatewaygetStreetGatewayByIndex (uint32 streetGatewayIndex)
 Get street street gateway with specified index. More...
 
const StreetGatewaygetStreetGatewayByIndex (size_t streetGatewayIndex) const
 
uint32 getAiNavigationMapId () const
 Return the ID of the AI navigation map that should use this data as input. More...
 
void setAiNavigationMapId (uint32 id)
 Set the ID of the AI navigation map that should use this data as input. 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 uint32 getMiniumNumberOfNodes () const
 Return the minimum number of nodes the concrete nodes component instance needs to be valid. More...
 
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...
 
virtual void setDebug (bool debugMode)
 Set whether or not the component is considered to be in debug mode. 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::StreetSectionComponent" unique component ID More...
 
static const uint32 BASE_MESH
 "BaseMesh" unique class property ID inside the class More...
 
static const uint32 FLIP_X_AXIS
 "FlipXAxis" unique class property ID inside the class More...
 
static const uint32 FLIP_Y_AXIS
 "FlipYAxis" unique class property ID inside the class More...
 
static const uint32 BLEND_OUT_LENGTH_AT_END
 "BlendOutLengthAtEnd" unique class property ID inside the class More...
 
static const uint32 BLEND_OUT_LENGTH_AT_START
 "BlendOutLengthAtStart" unique class property ID inside the class More...
 
static const uint32 STREETSECTION_NUM_LODS = 1
 
static int STREETSECTION_SEGMENTS_MIN [STREETSECTION_NUM_LODS]
 
static int STREETSECTION_SEGMENTS_MAX [STREETSECTION_NUM_LODS]
 
- Static Public Attributes inherited from qsf::StreetComponent
static const uint32 COMPONENT_ID
 "qsf::StreetComponent" unique component ID More...
 
static const uint32 STREET_GATEWAYS
 "StreetGateways" unique class property ID inside the class More...
 
static const uint32 AI_NAVIGATION_MAP_ID
 "AiNavigationMapId" 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 void startDebugDrawing () override
 Start debug visualization. More...
 
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 bool onStartup () override
 Startup the component. More...
 
virtual void onShutdown () override
 Shutdown the component. More...
 
- Protected Member Functions inherited from qsf::StreetComponent
virtual bool closedContinuousLines () const override
 Return whether or not closed continuous lines are used. More...
 
 QSF_CAMP_RTTI () QSF_CAMP_ARRAY_PROPERTY(StreetGateways
 
- Protected Member Functions inherited from qsf::NodesComponent
virtual void onSetDebugFlagSet ()
 Called if there's a debug flag set change. More...
 
virtual void onUpdateNodes ()
 
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 onComponentTransformChange (const Transform &transform, TransformChangeFlags flags)
 Called in case a component transformation value was changed. More...
 
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...
 
- 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::StreetComponent
std::vector< StreetGatewaymStreetGateways
 Contains all street gateways of the street component, this list must keep free of duplicates. More...
 
uint32 mAiNavigationMapId
 Used as a selector which AI navigation map uses this street component as input. More...
 
 StreetComponent
 
- 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

Street section component class.

Note
  • This class is the part between two street crossings
  • The street section component takes care that the procedural OGRE mesh is generated and tells the mesh component about the procedural mesh
  • Technically quite similar to "qsf::PathMeshComponent"
Todo:
  • TODO(np) If the node points are to close, the street becomes corrupt. Need to implement exceptional cases
  • TODO(co) When saving the OGRE mesh, do also automatically generate mesh LODs by e.g. reducing the number of segments within lower LODs

Definition at line 51 of file StreetSectionComponent.h.

Constructor & Destructor Documentation

qsf::StreetSectionComponent::StreetSectionComponent ( Prototype prototype)
inlineexplicit

Constructor.

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

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

qsf::StreetSectionComponent::~StreetSectionComponent ( )
inlinevirtual

Destructor.

Definition at line 30 of file StreetSectionComponent-inl.h.

Member Function Documentation

virtual void qsf::StreetSectionComponent::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::StreetSectionComponent::calculateDerivedNodePositions ( std::vector< glm::vec3 > &  derivedNodes,
int  segmentsMin,
int  segmentsMax 
) const

Calculate the derived node positions.

Parameters
[out]derivedNodesWill receive the derived local space node positions, list is not cleared before new entries are added
[in]segmentsMinThe minimum segments when the street section is straight. This value should have a minimum of 4 to prevent artefacts in curve creation.
[in]segmentsMaxThe maximum segments when the curve becomes spiky
void qsf::StreetSectionComponent::dirtyMesh ( )

Mark the procedural street mesh to be dirty.

Note
  • Please do only call this method if you have to and you know what you're doing
const AssetProxy & qsf::StreetSectionComponent::getBaseMesh ( ) const
inline

Return the base mesh asset to use.

Returns
The base mesh asset to use (e.g. "sample/mesh/default/street_01c"), do no destroy the returned instance
Note
  • Connected to the CAMP reflection system

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

const StreetGatewayLink & qsf::StreetSectionComponent::getBeginStreetGatewayLink ( ) const
inline

Return the street gateway begin link.

Returns
The street gateway begin link, do not destroy the instance
Note
  • Connected to the CAMP reflection system

Definition at line 60 of file StreetSectionComponent-inl.h.

float qsf::StreetSectionComponent::getBlendOutLengthAtEnd ( ) const
inline

Return the length of the blend out at the end of the path.

Returns
Length of the blend out
Note
  • Connected to the CAMP reflection system

Definition at line 55 of file StreetSectionComponent-inl.h.

float qsf::StreetSectionComponent::getBlendOutLengthAtStart ( ) const
inline

Return the length of the blend out at the start of the path.

Returns
Length of the blend out
Note
  • Connected to the CAMP reflection system

Definition at line 50 of file StreetSectionComponent-inl.h.

const StreetGatewayLink & qsf::StreetSectionComponent::getEndStreetGatewayLink ( ) const
inline

Return the street gateway end link.

Returns
The street gateway end link, do not destroy the instance
Note
  • Connected to the CAMP reflection system

Definition at line 66 of file StreetSectionComponent-inl.h.

bool qsf::StreetSectionComponent::getFlipXAxis ( ) const
inline

Return whether or not the x axis should be flipped.

Returns
"true" if the x axis should be flipped, else "false"
Note
  • Connected to the CAMP reflection system

Definition at line 40 of file StreetSectionComponent-inl.h.

bool qsf::StreetSectionComponent::getFlipYAxis ( ) const
inline

Return whether or not the y axis should be flipped.

Returns
"true" if the y axis should be flipped, else "false"
Note
  • Connected to the CAMP reflection system

Definition at line 45 of file StreetSectionComponent-inl.h.

float qsf::StreetSectionComponent::getLength ( ) const

Return the length from first point till last point.

Returns
The length from first point till last point
Note
  • Connected to the CAMP reflection system
virtual glm::vec3 qsf::StreetSectionComponent::getStreetGatewayDirection ( uint32  streetGatewayIndex) const
overridevirtual

Get direction of a street gateway with specified index.

Parameters
[in]streetGatewayIndexStreet gateway index
Returns
Local space direction of street gateway

Implements qsf::StreetComponent.

virtual glm::vec3 qsf::StreetSectionComponent::getStreetGatewayPosition ( uint32  streetGatewayIndex) const
overridevirtual

Get position of a street gateway with specified index.

Parameters
[in]streetGatewayIndexStreet gateway index
Returns
Local space position of gateway

Implements qsf::StreetComponent.

virtual bool qsf::StreetSectionComponent::implementsOnComponentPropertyChange ( ) const
inlineoverrideprotectedvirtual

Signal whether this component needs the "onComponentPropertyChange" callback at all.

Returns
If "true", this component can receive property change callbacks, otherwise "onComponentPropertyChange" won't get called

Reimplemented from qsf::NodesComponent.

Definition at line 326 of file StreetSectionComponent.h.

virtual void qsf::StreetSectionComponent::onComponentPropertyChange ( const Component component,
uint32  propertyId 
)
overrideprotectedvirtual

Called in case a component property value was changed.

Parameters
[in]componentComponent instance which had a property value change
[in]propertyIdUnique class property ID the component property which values was changed
Note
  • The default implementation is empty
  • The unique class property identifier is generated by "qsf::StringHash" by using the class property name (e.g. qsf::StringHash("Position") generating the hash value 3091144222)

Reimplemented from qsf::NodesComponent.

virtual void qsf::StreetSectionComponent::onShutdown ( )
overrideprotectedvirtual

Shutdown the component.

Note
  • Only called in case "onStartup()" returned successfully
  • The default implementation is empty

Reimplemented from qsf::Component.

virtual bool qsf::StreetSectionComponent::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.

virtual void qsf::StreetSectionComponent::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::StreetComponent.

void qsf::StreetSectionComponent::setBaseMesh ( const AssetProxy baseMesh)

Set the base mesh asset to use.

Parameters
[in]baseMeshThe base mesh asset to use (e.g. "sample/mesh/default/street_01c")
Note
  • Connected to the CAMP reflection system
void qsf::StreetSectionComponent::setBlendOutLengthAtEnd ( float  blendOutLengthAtEnd)

Set how long the blend out is at the end of the path.

Parameters
[in]blendOutLengthLength of the blend out
Note
  • Connected to the CAMP reflection system
void qsf::StreetSectionComponent::setBlendOutLengthAtStart ( float  blendOutLengthAtStart)

Set how long the blend out is at the start of the path.

Parameters
[in]blendOutLengthLength of the blend out
Note
  • Connected to the CAMP reflection system
void qsf::StreetSectionComponent::setFlipXAxis ( bool  flipXAxis)

Set whether or not the x axis should be flipped.

Parameters
[in]flipXAxis"true" if the x axis should be flipped, else "false"
Note
  • Connected to the CAMP reflection system
void qsf::StreetSectionComponent::setFlipYAxis ( bool  flipYAxis)

Set whether or not the y axis should be flipped.

Parameters
[in]flipYAxis"true" if the y axis should be flipped, else "false"
Note
  • Connected to the CAMP reflection system
virtual void qsf::StreetSectionComponent::setNode ( std::size_t  index,
const Node value 
)
overridevirtual

Reimplemented from qsf::NodesComponent.

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

Reimplemented from qsf::NodesComponent.

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

Reimplemented from qsf::NodesComponent.

void qsf::StreetSectionComponent::snapTierNodeToPositionDirection ( uint32  tierNodeIndex,
const glm::vec3 &  localSpacePosition,
const glm::vec3 &  localSpaceDirection 
)

Snap the given tier node to the given position.

Parameters
[in]tierNodeIndexIndex of the tied node to snap
[in]localSpacePositionLocal space position to snap the given tier node to
[in]localSpaceDirectionNormalized local space direction used during snapping
Note
  • This method automatically respects the tier constraints
virtual void qsf::StreetSectionComponent::startDebugDrawing ( )
overrideprotectedvirtual

Start debug visualization.

Reimplemented from qsf::NodesComponent.

Member Data Documentation

const uint32 qsf::StreetSectionComponent::BASE_MESH
static

"BaseMesh" unique class property ID inside the class

Definition at line 60 of file StreetSectionComponent.h.

const uint32 qsf::StreetSectionComponent::BLEND_OUT_LENGTH_AT_END
static

"BlendOutLengthAtEnd" unique class property ID inside the class

Definition at line 63 of file StreetSectionComponent.h.

const uint32 qsf::StreetSectionComponent::BLEND_OUT_LENGTH_AT_START
static

"BlendOutLengthAtStart" unique class property ID inside the class

Definition at line 64 of file StreetSectionComponent.h.

const uint32 qsf::StreetSectionComponent::COMPONENT_ID
static

"qsf::StreetSectionComponent" unique component ID

Definition at line 59 of file StreetSectionComponent.h.

const uint32 qsf::StreetSectionComponent::FLIP_X_AXIS
static

"FlipXAxis" unique class property ID inside the class

Definition at line 61 of file StreetSectionComponent.h.

const uint32 qsf::StreetSectionComponent::FLIP_Y_AXIS
static

"FlipYAxis" unique class property ID inside the class

Definition at line 62 of file StreetSectionComponent.h.

const uint32 qsf::StreetSectionComponent::STREETSECTION_NUM_LODS = 1
static

Definition at line 67 of file StreetSectionComponent.h.

int qsf::StreetSectionComponent::STREETSECTION_SEGMENTS_MAX[STREETSECTION_NUM_LODS]
static

Definition at line 70 of file StreetSectionComponent.h.

int qsf::StreetSectionComponent::STREETSECTION_SEGMENTS_MIN[STREETSECTION_NUM_LODS]
static

Definition at line 69 of file StreetSectionComponent.h.


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