Simplygon C++ API  8.3.35800.0
Public Member Functions | Static Public Member Functions | List of all members
SimplygonSDK::ISceneBone Class Referenceabstract

#include <SimplygonSDK.h>

Inheritance diagram for SimplygonSDK::ISceneBone:
SimplygonSDK::ISceneNode SimplygonSDK::IObject

Public Member Functions

virtual void CollectAllChildBones (IRidArray *child_bones)=0
 
virtual rid GetBoneId ()=0
 
virtual const char * GetClass ()
 
virtual rid GetParentBone ()=0
 
virtual bool IsA (const char *type) const
 
- Public Member Functions inherited from SimplygonSDK::ISceneNode
virtual void AddChild (ISceneNode *child)=0
 
virtual bool CalculateExtents ()=0
 
virtual CountedPointer< ISceneMesh > CreateChildMesh (IGeometryData *geom)=0
 
virtual CountedPointer< IScenePlane > CreateChildPlane (const real *position_realInputDataPtr, const real *normal_realInputDataPtr)=0
 
virtual void EvaluateDefaultGlobalTransformation (IMatrix4x4 *global_transform)=0
 
virtual CountedPointer< ISceneNode > FindNamedChild (const char *name)=0
 
virtual CountedPointer< ISceneNode > GetChild (rid index)=0
 
virtual unsigned int GetChildCount ()=0
 
virtual void GetInf (real *realReturnDataPtr)=0
 
virtual bool GetIsFrozen ()=0
 
virtual bool GetIsModified ()=0
 
virtual bool GetIsVisible ()=0
 
virtual rstring GetNodeGUID ()=0
 
virtual rstring GetOriginalName ()=0
 
virtual CountedPointer< ISceneNode > GetParent ()=0
 
virtual rstring GetPath ()=0
 
virtual CountedPointer< IMatrix4x4 > GetRelativeTransform ()=0
 
virtual CountedPointer< IScene > GetScene ()=0
 
virtual void GetSup (real *realReturnDataPtr)=0
 
virtual bool HasChild (ISceneNode *child)=0
 
virtual CountedPointer< ISceneNode > NewClone ()=0
 
virtual CountedPointer< ISceneNode > NewCopy ()=0
 
virtual void RemoveChild (ISceneNode *child)=0
 
virtual void RemoveChildren ()=0
 
virtual void RemoveFromParent ()=0
 
virtual void SetIsFrozen (bool value)=0
 
virtual void SetIsModified (bool value)=0
 
virtual void SetIsVisible (bool value)=0
 
virtual void SetNodeGUID (const char *value)=0
 
virtual void SetOriginalName (const char *value)=0
 
- Public Member Functions inherited from SimplygonSDK::IObject
virtual rid AddObserver (robserver *Observer, rid EventId)=0
 
virtual void AddRef ()=0
 
virtual rstring GetName ()=0
 
virtual void * GetUserComponentArea (rid userid)=0
 
virtual void PrintInfo ()=0
 
virtual void Release ()=0
 
virtual void RemoveObserver (rid ObserverId)=0
 
virtual void SetName (const char *Name)=0
 

Static Public Member Functions

static bool IsClassA (const char *type)
 
static ISceneBone * SafeCast (IObject *ptr)
 
- Static Public Member Functions inherited from SimplygonSDK::ISceneNode
static bool IsClassA (const char *type)
 
static ISceneNode * SafeCast (IObject *ptr)
 
- Static Public Member Functions inherited from SimplygonSDK::IObject
static bool IsClassA (const char *type)
 
static IObject * SafeCast (IObject *ptr)
 

Detailed Description

ISceneBone is the bone node in the simplygon scene graph

Definition at line 14822 of file SimplygonSDK.h.

Member Function Documentation

◆ CollectAllChildBones()

virtual void SimplygonSDK::ISceneBone::CollectAllChildBones ( IRidArray *  child_bones)
pure virtual

Looks through the sub-tree and collects the IDs of the bones found.

Parameters
child_bonesis the array to which the ids of found child bones will be written

◆ GetBoneId()

virtual rid SimplygonSDK::ISceneBone::GetBoneId ( )
pure virtual

Get the BoneId

Returns
the id of the current scene bone

◆ GetClass()

virtual const char* SimplygonSDK::ISceneBone::GetClass ( )
virtual

GetClass returns the name of the class of the object.

Returns
the name of the actual class of the object, as a const char string

Reimplemented from SimplygonSDK::ISceneNode.

◆ GetParentBone()

virtual rid SimplygonSDK::ISceneBone::GetParentBone ( )
pure virtual

Looks through the hierarchy and fetches the previous BoneNode. If none is found, this is a Root-Bone-Node. -1 means it has no parent, otherwise, the ID is the parent ID.

Returns
the id of the parent bone, or -1 if no parent exists

◆ IsA()

virtual bool SimplygonSDK::ISceneBone::IsA ( const char *  type) const
virtual

The IsA function returns true if the object is a or is a descendant of the class named as the type parameter

Parameters
typeis the name of the class to check if the object is, or is a descendant of
Returns
true if the object is of the specified class, false if not

Reimplemented from SimplygonSDK::ISceneNode.

◆ IsClassA()

static bool SimplygonSDK::ISceneBone::IsClassA ( const char *  type)
inlinestatic

The IsClassA function returns true if ISceneBone is a or is a descendant of the class named as the type parameter

Parameters
typeis the name of the class to check if the class is, or is a descendant of
Returns
true if the class is of the specified class, false if not

Definition at line 14843 of file SimplygonSDK.h.

◆ SafeCast()

static ISceneBone* SimplygonSDK::ISceneBone::SafeCast ( IObject *  ptr)
inlinestatic

SafeCast makes sure the pointer is of a class that can be cast into a ISceneBone pointer, and if this is possible, returns the cast pointer.

Parameters
ptris the pointer to be cast into a ISceneBone pointer
Returns
a pointer to the ISceneBone object, if the cast can be made, and a NULL pointer otherwise

Definition at line 14856 of file SimplygonSDK.h.

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