Polyphase Game Engine
Loading...
Searching...
No Matches
Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
Node3D Class Reference

#include <Node3d.h>

Inheritance diagram for Node3D:
Node Object AnimatedSprite3D Audio3D Camera3D Light3D Primitive3D Spline3D DirectionalLight3D PointLight3D Box3D Capsule3D Mesh3D Particle3D Sphere3D NavMesh3D SkeletalMesh3D StaticMesh3D Terrain3D TextMesh3D TileMap2D Voxel3D InstancedMesh3D ShadowMesh3D Skybox3D TestSpinner

Public Member Functions

 DECLARE_NODE (Node3D, Node)
 
 Node3D ()
 
virtual ~Node3D ()
 
virtual void Create () override
 
virtual void Destroy () override
 
virtual void Tick (float deltaTime) override
 
virtual const char * GetTypeName () const override
 
virtual void GatherProperties (std::vector< Property > &outProps) override
 
virtual void GatherReplicatedData (std::vector< NetDatum > &outData)
 
virtual bool IsNode3D () const override
 
void AttachToBone (SkeletalMesh3D *parent, const char *boneName, bool keepWorldTransform=false, int32_t childIndex=-1)
 
void AttachToBone (SkeletalMesh3D *parent, int32_t boneIndex, bool keepWorldTransform=false, int32_t childIndex=-1)
 
void MarkTransformDirty ()
 
bool IsTransformDirty () const
 
virtual void UpdateTransform (bool updateChildren)
 
virtual bool CheckNetRelevance (Node *playerNode) override
 
virtual void GatherProxyDraws (std::vector< DebugDraw > &inoutDraws)
 
glm::vec3 GetPosition () const
 
glm::vec3 GetRotationEuler () const
 
glm::quat GetRotationQuat () const
 
glm::vec3 GetScale () const
 
glm::vec3 & GetPositionRef ()
 
glm::vec3 & GetRotationEulerRef ()
 
glm::quat & GetRotationQuatRef ()
 
glm::vec3 & GetScaleRef ()
 
const glm::mat4 & GetTransform ()
 
void SetPosition (glm::vec3 position)
 
void SetRotation (glm::vec3 rotation)
 
void SetRotation (glm::quat quat)
 
void SetScale (glm::vec3 scale)
 
virtual void SetTransform (const glm::mat4 &transform)
 
glm::vec3 GetWorldPosition ()
 
glm::vec3 GetWorldRotationEuler ()
 
glm::quat GetWorldRotationQuat ()
 
glm::vec3 GetWorldScale ()
 
void SetWorldPosition (glm::vec3 position)
 
void SetWorldRotation (glm::vec3 rotation)
 
void SetWorldRotation (glm::quat rotation)
 
void SetWorldScale (glm::vec3 scale)
 
void AddRotation (glm::quat rotation)
 
void AddRotation (glm::vec3 rotation)
 
void AddWorldRotation (glm::quat rotation)
 
void AddWorldRotation (glm::vec3 rotation)
 
void RotateAround (glm::vec3 pivot, glm::vec3 axis, float degrees)
 
void LookAt (glm::vec3 target, glm::vec3 up)
 
glm::vec3 GetCachedEulerRotation () const
 
glm::vec3 GetForwardVector ()
 
glm::vec3 GetRightVector ()
 
glm::vec3 GetUpVector ()
 
glm::mat4 GetParentTransform ()
 
int32_t GetParentBoneIndex () const
 
bool GetInheritTransform () const
 
void SetInheritTransform (bool inheritTransform)
 
virtual void Attach (Node *parent, bool keepWorldTransform=false, int32_t index=-1) override
 
- Public Member Functions inherited from Node
 DECLARE_FACTORY_MANAGER (Node)
 
 DECLARE_FACTORY (Node, Node)
 
 DECLARE_OBJECT (Node, Object)
 
 DECLARE_SCRIPT_LINK_BASE (Node)
 
 Node ()
 
virtual ~Node ()
 
void DestroyDeferred ()
 
void Doom ()
 
virtual void SaveStream (Stream &stream, Platform platform)
 
virtual void LoadStream (Stream &stream, Platform platform, uint32_t version)
 
virtual void Copy (Node *srcNode, bool recurse)
 
virtual void Render (PipelineConfig pipelineConfig)
 
virtual void Awake ()
 
virtual void Start ()
 
virtual void Stop ()
 
virtual void PrepareTick (std::vector< NodePtrWeak > &outTickNodes, bool game, bool recurse)
 
virtual void EditorTick (float deltaTime)
 
uint32_t GetLastTickedFrame () const
 
virtual void Render ()
 
virtual void OnInstanced ()
 
virtual VertexType GetVertexType () const
 
virtual void GatherNetFuncs (std::vector< NetFunc > &outFuncs)
 
void GatherPropertyOverrides (std::vector< Property > &outOverrides)
 
void ApplyPropertyOverrides (const std::vector< Property > &overs)
 
virtual void BeginOverlap (Primitive3D *thisComp, Primitive3D *otherComp)
 
virtual void EndOverlap (Primitive3D *thisComp, Primitive3D *otherComp)
 
virtual void OnCollision (Primitive3D *thisComp, Primitive3D *otherComp, glm::vec3 impactPoint, glm::vec3 impactNormal, btPersistentManifold *manifold)
 
NodeId GetNodeId () const
 
uint64_t GetPersistentUuid () const
 
void SetPersistentUuid (uint64_t uuid)
 
void EnsurePersistentUuid ()
 
void EmitSignal (const std::string &name, const std::vector< Datum > &args)
 
void ConnectSignal (const std::string &name, Node *listener, SignalHandlerFP func)
 
void ConnectSignal (const std::string &name, Node *listener, const ScriptFunc &func)
 
void DisconnectSignal (const std::string &name, Node *listener)
 
void RenderShadow ()
 
void RenderSelected (bool renderChildren)
 
Node * CreateChild (TypeId nodeType)
 
Node * CreateChild (const char *typeName)
 
Node * CreateChildClone (Node *srcNode, bool recurse)
 
NodePtr Clone (bool recurse, bool instantiateLinkedScene=true, bool resolveNodePaths=false)
 
void DestroyAllChildren ()
 
Node * GetRoot ()
 
bool IsWorldRoot () const
 
Node * GetSubRoot ()
 
template<class NodeClass >
NodeClass * CreateChild ()
 
template<class NodeClass >
SharedPtr< NodeClass > CreateChildSp ()
 
template<class NodeClass >
NodeClass * CreateChild (const char *name)
 
template<class NodeClass >
SharedPtr< NodeClass > CreateChildSp (const char *name)
 
bool IsDestroyed () const
 
bool IsPendingDestroy () const
 
bool IsDoomed () const
 
bool HasStarted () const
 
bool HasAwoken () const
 
void EnableTick (bool enable)
 
bool IsTickEnabled () const
 
virtual void SetWorld (World *world, bool subRoot)
 
World * GetWorld ()
 
void SetScene (Scene *scene)
 
Scene * GetScene ()
 
uint8_t GetTargetScreen () const
 
void SetTargetScreen (uint8_t screen)
 
std::vector< NetDatum > & GetReplicatedData ()
 
void SetNetId (NetId id)
 
NetId GetNetId () const
 
NetHostId GetOwningHost () const
 
void SetOwningHost (NetHostId hostId, bool setAsPawn=false)
 
void SetReplicate (bool replicate)
 
bool IsReplicated () const
 
void SetReplicateTransform (bool repTransform)
 
bool IsTransformReplicated () const
 
void ForceReplication ()
 
void ClearForcedReplication ()
 
bool NeedsForcedReplication ()
 
bool IsAlwaysRelevant () const
 
void SetAlwaysRelevant (bool alwaysRelevant)
 
bool HasTag (const std::string &tag)
 
void AddTag (const std::string &tag)
 
void RemoveTag (const std::string &tag)
 
void SetName (const std::string &newName)
 
const std::string & GetName () const
 
virtual void SetActive (bool active)
 
bool IsActive (bool recurse=false) const
 
virtual void SetVisible (bool visible)
 
bool IsVisible (bool recurse=false) const
 
void SetTransient (bool transient)
 
virtual bool IsTransient () const
 
void SetPersistent (bool persistent)
 
bool IsPersistent () const
 
void SetDefault (bool isDefault)
 
bool IsDefault () const
 
void SetUserdataCreated (bool created)
 
bool IsUserdataCreated () const
 
virtual DrawData GetDrawData ()
 
virtual bool IsWidget () const
 
virtual bool IsPrimitive3D () const
 
virtual bool IsLight3D () const
 
Node * GetParent ()
 
const Node * GetParent () const
 
const std::vector< NodePtr > & GetChildren () const
 
void Detach (bool keepWorldTransform=false)
 
void AddChild (Node *child, int32_t index=-1)
 
void RemoveChild (Node *child)
 
void RemoveChild (int32_t index)
 
template<typename T >
void AddChild (const SharedPtr< T > &child, int32_t index=-1)
 
template<typename T >
void RemoveChild (const SharedPtr< Node > &child)
 
int32_t FindChildIndex (const std::string &name) const
 
int32_t FindChildIndex (Node *child) const
 
Node * FindChild (const std::string &name, bool recurse) const
 
Node * FindChildWithTag (const std::string &name, bool recurse) const
 
Node * FindDescendant (const std::string &name)
 
Node * FindAncestor (const std::string &name)
 
bool HasAncestor (Node *node)
 
Node * GetChild (int32_t index) const
 
Node * GetChildByType (TypeId type) const
 
uint32_t GetNumChildren () const
 
int32_t FindParentNodeIndex () const
 
void SetHitCheckId (uint32_t id)
 
uint32_t GetHitCheckId () const
 
bool IsLateTickEnabled () const
 
void EnableLateTick (bool enable)
 
Script * GetScript ()
 
void SetScriptFile (const std::string &fileName)
 
bool DoChildrenHaveUniqueNames () const
 
void BreakSceneLink ()
 
bool IsSceneLinked (bool ignoreInPie=true) const
 
bool IsSceneLinkedChild (bool ignoreInPie=true)
 
bool IsForeign () const
 
bool HasAuthority () const
 
bool IsOwned () const
 
bool IsLocallyControlled () const
 
Datum GetField (const std::string &key)
 
void SetField (const std::string &name, const Datum &value)
 
Datum GetField (int32_t key)
 
void SetField (int32_t key, const Datum &value)
 
Datum CallFunction (const std::string &name, const std::vector< Datum > &args={})
 
NetFunc * FindNetFunc (const char *name)
 
NetFunc * FindNetFunc (uint16_t index)
 
void InvokeNetFunc (const char *name)
 
void InvokeNetFunc (const char *name, Datum param0)
 
void InvokeNetFunc (const char *name, Datum param0, Datum param1)
 
void InvokeNetFunc (const char *name, Datum param0, Datum param1, Datum param2)
 
void InvokeNetFunc (const char *name, Datum param0, Datum param1, Datum param2, Datum param3)
 
void InvokeNetFunc (const char *name, Datum param0, Datum param1, Datum param2, Datum param3, Datum param4)
 
void InvokeNetFunc (const char *name, Datum param0, Datum param1, Datum param2, Datum param3, Datum param4, Datum param5)
 
void InvokeNetFunc (const char *name, Datum param0, Datum param1, Datum param2, Datum param3, Datum param4, Datum param5, Datum param6)
 
void InvokeNetFunc (const char *name, Datum param0, Datum param1, Datum param2, Datum param3, Datum param4, Datum param5, Datum param6, Datum param7)
 
void InvokeNetFunc (const char *name, const std::vector< Datum > &params)
 
const WeakPtr< Node > & GetSelfPtr () const
 
template<typename T >
T * FindChild (const std::string &name, bool recurse)
 
template<typename T >
void Traverse (T func, bool inverted=false)
 
template<typename T >
bool ForEach (T func, bool inverted=false)
 
- Public Member Functions inherited from Object
virtual ~Object ()=default
 
virtual const char * RuntimeName () const =0
 
virtual const char * RuntimeParentName () const =0
 
virtual RuntimeId InstanceRuntimeId () const =0
 
virtual Object * QueryInterface (RuntimeId id) const
 
virtual bool Is (RuntimeId id) const
 
virtual bool Is (const char *name) const
 
virtual bool DrawCustomProperty (Property &prop)
 
template<typename T >
T * As () const
 
virtual bool Equals (const Object *rhs) const
 

Static Public Member Functions

static bool OnRep_RootPosition (Datum *datum, uint32_t index, const void *newValue)
 
static bool OnRep_RootRotation (Datum *datum, uint32_t index, const void *newValue)
 
static bool OnRep_RootScale (Datum *datum, uint32_t index, const void *newValue)
 
- Static Public Member Functions inherited from Node
static NodePtr Construct (const std::string &name)
 
static NodePtr Construct (TypeId typeId)
 
static void Destruct (Node *node)
 
static void ProcessPendingDestroys ()
 
static void RegisterNetFuncs (Node *node)
 
static void Deleter (Node *node)
 
template<class NodeClass >
static SharedPtr< NodeClass > Construct ()
 
- Static Public Member Functions inherited from Object
static const char * ClassRuntimeName ()
 

Protected Member Functions

virtual void SetParent (Node *parent) override
 
- Protected Member Functions inherited from Node
void TickCommon (float deltaTime)
 
void ValidateUniqueChildName (Node *newChild)
 
void SendNetFunc (NetFunc *func, uint32_t numParams, const Datum **params)
 

Protected Attributes

glm::vec3 mPosition
 
glm::vec3 mRotationEuler
 
glm::vec3 mScale
 
glm::quat mRotationQuat
 
glm::mat4 mTransform
 
int32_t mParentBoneIndex
 
bool mInheritTransform = true
 
bool mTransformDirty
 
- Protected Attributes inherited from Node
std::string mName
 
World * mWorld = nullptr
 
NodePtrWeak mParent
 
NodePtrWeak mSelf
 
std::vector< NodePtr > mChildren
 
std::unordered_map< std::string, Node * > mChildNameMap
 
std::unordered_map< std::string, Signal > mSignalMap
 
std::string mScriptFile
 
uint32_t mLastTickedFrame = 0
 
bool mActive = true
 
bool mVisible = true
 
bool mTransient = false
 
bool mPersistent = false
 
bool mDefault = false
 
bool mUserdataCreated = false
 
bool mHasStarted = false
 
bool mHasAwoken = false
 
bool mDestroyed = false
 
bool mTickEnabled = true
 
bool mLateTick = false
 
SceneRef mScene
 
uint8_t mTargetScreen = 0
 
std::vector< std::string > mTags
 
NodeId mNodeId = INVALID_NODE_ID
 
uint64_t mPersistentUuid = 0
 
std::vector< NetDatum > mReplicatedData
 
NetId mNetId = INVALID_NET_ID
 
NetHostId mOwningHost = INVALID_HOST_ID
 
bool mReplicate = false
 
bool mReplicateTransform = false
 
bool mForceReplicate = false
 
bool mAlwaysRelevant = true
 
Script * mScript = nullptr
 

Additional Inherited Members

- Static Protected Member Functions inherited from Node
static bool HandlePropChange (Datum *datum, uint32_t index, const void *newValue)
 
static bool OnRep_OwningHost (Datum *datum, uint32_t index, const void *newValue)
 
- Static Protected Attributes inherited from Node
static std::unordered_map< TypeId, NetFuncMap > sTypeNetFuncMap
 
static std::unordered_set< NodePtrWeak > sPendingDestroySet
 
static NodeId sNextNodeId = NodeId(1)
 

Constructor & Destructor Documentation

◆ Node3D()

Node3D::Node3D ( )

◆ ~Node3D()

Node3D::~Node3D ( )
virtual

Member Function Documentation

◆ AddRotation() [1/2]

void Node3D::AddRotation ( glm::quat  rotation)

◆ AddRotation() [2/2]

void Node3D::AddRotation ( glm::vec3  rotation)

◆ AddWorldRotation() [1/2]

void Node3D::AddWorldRotation ( glm::quat  rotation)

◆ AddWorldRotation() [2/2]

void Node3D::AddWorldRotation ( glm::vec3  rotation)

◆ Attach()

void Node3D::Attach ( Node *  parent,
bool  keepWorldTransform = false,
int32_t  index = -1 
)
overridevirtual

Reimplemented from Node.

◆ AttachToBone() [1/2]

void Node3D::AttachToBone ( SkeletalMesh3D *  parent,
const char *  boneName,
bool  keepWorldTransform = false,
int32_t  childIndex = -1 
)

◆ AttachToBone() [2/2]

void Node3D::AttachToBone ( SkeletalMesh3D *  parent,
int32_t  boneIndex,
bool  keepWorldTransform = false,
int32_t  childIndex = -1 
)

◆ CheckNetRelevance()

bool Node3D::CheckNetRelevance ( Node *  playerNode)
overridevirtual

Reimplemented from Node.

◆ Create()

void Node3D::Create ( )
overridevirtual

Reimplemented from Node.

Reimplemented in AnimatedSprite3D, Audio3D, Box3D, Capsule3D, InstancedMesh3D, NavMesh3D, Particle3D, PointLight3D, Primitive3D, ShadowMesh3D, SkeletalMesh3D, Skybox3D, Sphere3D, Spline3D, StaticMesh3D, Terrain3D, TestSpinner, TextMesh3D, TileMap2D, and Voxel3D.

◆ DECLARE_NODE()

Node3D::DECLARE_NODE ( Node3D  ,
Node   
)

◆ Destroy()

void Node3D::Destroy ( )
overridevirtual

Reimplemented from Node.

Reimplemented in AnimatedSprite3D, Audio3D, Camera3D, DirectionalLight3D, InstancedMesh3D, Particle3D, PointLight3D, Primitive3D, ShadowMesh3D, SkeletalMesh3D, StaticMesh3D, Terrain3D, TestSpinner, TextMesh3D, TileMap2D, and Voxel3D.

◆ GatherProperties()

void Node3D::GatherProperties ( std::vector< Property > &  outProps)
overridevirtual

Reimplemented from Node.

Reimplemented in AnimatedSprite3D, Audio3D, Box3D, Camera3D, Capsule3D, DirectionalLight3D, InstancedMesh3D, Light3D, Mesh3D, NavMesh3D, Particle3D, PointLight3D, Primitive3D, ShadowMesh3D, SkeletalMesh3D, Skybox3D, Sphere3D, StaticMesh3D, Terrain3D, TextMesh3D, TileMap2D, Voxel3D, Spline3D, and TestSpinner.

◆ GatherProxyDraws()

void Node3D::GatherProxyDraws ( std::vector< DebugDraw > &  inoutDraws)
virtual

Reimplemented in Audio3D, Box3D, Camera3D, Capsule3D, DirectionalLight3D, InstancedMesh3D, NavMesh3D, Particle3D, PointLight3D, Primitive3D, ShadowMesh3D, Sphere3D, Spline3D, and StaticMesh3D.

◆ GatherReplicatedData()

void Node3D::GatherReplicatedData ( std::vector< NetDatum > &  outData)
virtual

Reimplemented from Node.

◆ GetCachedEulerRotation()

glm::vec3 Node3D::GetCachedEulerRotation ( ) const

◆ GetForwardVector()

glm::vec3 Node3D::GetForwardVector ( )

◆ GetInheritTransform()

bool Node3D::GetInheritTransform ( ) const

◆ GetParentBoneIndex()

int32_t Node3D::GetParentBoneIndex ( ) const

◆ GetParentTransform()

glm::mat4 Node3D::GetParentTransform ( )

◆ GetPosition()

glm::vec3 Node3D::GetPosition ( ) const

◆ GetPositionRef()

glm::vec3 & Node3D::GetPositionRef ( )

◆ GetRightVector()

glm::vec3 Node3D::GetRightVector ( )

◆ GetRotationEuler()

glm::vec3 Node3D::GetRotationEuler ( ) const

◆ GetRotationEulerRef()

glm::vec3 & Node3D::GetRotationEulerRef ( )

◆ GetRotationQuat()

glm::quat Node3D::GetRotationQuat ( ) const

◆ GetRotationQuatRef()

glm::quat & Node3D::GetRotationQuatRef ( )

◆ GetScale()

glm::vec3 Node3D::GetScale ( ) const

◆ GetScaleRef()

glm::vec3 & Node3D::GetScaleRef ( )

◆ GetTransform()

const glm::mat4 & Node3D::GetTransform ( )

◆ GetTypeName()

const char * Node3D::GetTypeName ( ) const
overridevirtual

Reimplemented from Node.

Reimplemented in AnimatedSprite3D, Audio3D, Box3D, Camera3D, Capsule3D, DirectionalLight3D, InstancedMesh3D, Light3D, Mesh3D, NavMesh3D, Particle3D, PointLight3D, Primitive3D, ShadowMesh3D, SkeletalMesh3D, Skybox3D, Sphere3D, StaticMesh3D, Terrain3D, TextMesh3D, TileMap2D, and Voxel3D.

◆ GetUpVector()

glm::vec3 Node3D::GetUpVector ( )

◆ GetWorldPosition()

glm::vec3 Node3D::GetWorldPosition ( )

◆ GetWorldRotationEuler()

glm::vec3 Node3D::GetWorldRotationEuler ( )

◆ GetWorldRotationQuat()

glm::quat Node3D::GetWorldRotationQuat ( )

◆ GetWorldScale()

glm::vec3 Node3D::GetWorldScale ( )

◆ IsNode3D()

bool Node3D::IsNode3D ( ) const
overridevirtual

Reimplemented from Node.

◆ IsTransformDirty()

bool Node3D::IsTransformDirty ( ) const

◆ LookAt()

void Node3D::LookAt ( glm::vec3  target,
glm::vec3  up 
)

◆ MarkTransformDirty()

void Node3D::MarkTransformDirty ( )

◆ OnRep_RootPosition()

bool Node3D::OnRep_RootPosition ( Datum *  datum,
uint32_t  index,
const void *  newValue 
)
static

◆ OnRep_RootRotation()

bool Node3D::OnRep_RootRotation ( Datum *  datum,
uint32_t  index,
const void *  newValue 
)
static

◆ OnRep_RootScale()

bool Node3D::OnRep_RootScale ( Datum *  datum,
uint32_t  index,
const void *  newValue 
)
static

◆ RotateAround()

void Node3D::RotateAround ( glm::vec3  pivot,
glm::vec3  axis,
float  degrees 
)

◆ SetInheritTransform()

void Node3D::SetInheritTransform ( bool  inheritTransform)

◆ SetParent()

void Node3D::SetParent ( Node *  parent)
overrideprotectedvirtual

Reimplemented from Node.

◆ SetPosition()

void Node3D::SetPosition ( glm::vec3  position)

◆ SetRotation() [1/2]

void Node3D::SetRotation ( glm::quat  quat)

◆ SetRotation() [2/2]

void Node3D::SetRotation ( glm::vec3  rotation)

◆ SetScale()

void Node3D::SetScale ( glm::vec3  scale)

◆ SetTransform()

void Node3D::SetTransform ( const glm::mat4 &  transform)
virtual

Reimplemented in Primitive3D.

◆ SetWorldPosition()

void Node3D::SetWorldPosition ( glm::vec3  position)

◆ SetWorldRotation() [1/2]

void Node3D::SetWorldRotation ( glm::quat  rotation)

◆ SetWorldRotation() [2/2]

void Node3D::SetWorldRotation ( glm::vec3  rotation)

◆ SetWorldScale()

void Node3D::SetWorldScale ( glm::vec3  scale)

◆ Tick()

void Node3D::Tick ( float  deltaTime)
overridevirtual

Reimplemented from Node.

Reimplemented in AnimatedSprite3D, Audio3D, DirectionalLight3D, InstancedMesh3D, Particle3D, Primitive3D, SkeletalMesh3D, Spline3D, Terrain3D, TestSpinner, TextMesh3D, TileMap2D, and Voxel3D.

◆ UpdateTransform()

void Node3D::UpdateTransform ( bool  updateChildren)
virtual

Reimplemented in Primitive3D.

Member Data Documentation

◆ mInheritTransform

bool Node3D::mInheritTransform = true
protected

◆ mParentBoneIndex

int32_t Node3D::mParentBoneIndex
protected

◆ mPosition

glm::vec3 Node3D::mPosition
protected

◆ mRotationEuler

glm::vec3 Node3D::mRotationEuler
protected

◆ mRotationQuat

glm::quat Node3D::mRotationQuat
protected

◆ mScale

glm::vec3 Node3D::mScale
protected

◆ mTransform

glm::mat4 Node3D::mTransform
protected

◆ mTransformDirty

bool Node3D::mTransformDirty
protected
The documentation for this class was generated from the following files: