Simplygon C++ API  8.3.35800.0
SimplygonSDK::IScenePlane Class Referenceabstract

#include <SimplygonSDK.h>

Inheritance diagram for SimplygonSDK::IScenePlane:
SimplygonSDK::ISceneNode SimplygonSDK::IObject

Public Member Functions

virtual const char * GetClass ()
 
virtual void GetNormal (real *realReturnDataPtr)=0
 
virtual void GetPosition (real *realReturnDataPtr)=0
 
virtual bool IsA (const char *type) const
 
virtual void SetNormal (const real *vec_realInputDataPtr)=0
 
virtual void SetPosition (const real *vec_realInputDataPtr)=0
 
- Public Member Functions inherited from SimplygonSDK::ISceneNode
virtual void AddChild (ISceneNode *child)=0
 
virtual bool CalculateExtents ()=0
 
virtual CountedPointer< ISceneMeshCreateChildMesh (IGeometryData *geom)=0
 
virtual CountedPointer< IScenePlaneCreateChildPlane (const real *position_realInputDataPtr, const real *normal_realInputDataPtr)=0
 
virtual void EvaluateDefaultGlobalTransformation (IMatrix4x4 *global_transform)=0
 
virtual CountedPointer< ISceneNodeFindNamedChild (const char *name)=0
 
virtual CountedPointer< ISceneNodeGetChild (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< ISceneNodeGetParent ()=0
 
virtual rstring GetPath ()=0
 
virtual CountedPointer< IMatrix4x4GetRelativeTransform ()=0
 
virtual CountedPointer< ISceneGetScene ()=0
 
virtual void GetSup (real *realReturnDataPtr)=0
 
virtual bool HasChild (ISceneNode *child)=0
 
virtual CountedPointer< ISceneNodeNewClone ()=0
 
virtual CountedPointer< ISceneNodeNewCopy ()=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 IScenePlaneSafeCast (IObject *ptr)
 
- Static Public Member Functions inherited from SimplygonSDK::ISceneNode
static bool IsClassA (const char *type)
 
static ISceneNodeSafeCast (IObject *ptr)
 
- Static Public Member Functions inherited from SimplygonSDK::IObject
static bool IsClassA (const char *type)
 
static IObjectSafeCast (IObject *ptr)
 

Detailed Description

IScenePlane is the plane node in the simplygon scene graph that can be used in various processes, for example as a cutting plane in the RemeshingProcessor.

Definition at line 15002 of file SimplygonSDK.h.

Member Function Documentation

◆ GetClass()

virtual const char* SimplygonSDK::IScenePlane::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.

◆ GetNormal()

virtual void SimplygonSDK::IScenePlane::GetNormal ( real realReturnDataPtr)
pure virtual

Get the normal of the plane

Parameters
realReturnDataPtrpointer to a user-provided data area to receive the return value. Note! Needs to be at least 3 elements in size

◆ GetPosition()

virtual void SimplygonSDK::IScenePlane::GetPosition ( real realReturnDataPtr)
pure virtual

Get the position (translation) of the plane

Parameters
realReturnDataPtrpointer to a user-provided data area to receive the return value. Note! Needs to be at least 3 elements in size

◆ IsA()

virtual bool SimplygonSDK::IScenePlane::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::IScenePlane::IsClassA ( const char *  type)
inlinestatic

The IsClassA function returns true if IScenePlane 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 15023 of file SimplygonSDK.h.

◆ SafeCast()

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

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

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

Definition at line 15036 of file SimplygonSDK.h.

◆ SetNormal()

virtual void SimplygonSDK::IScenePlane::SetNormal ( const real vec_realInputDataPtr)
pure virtual

Set the normal of the plane

Parameters
vec_realInputDataPtrthe new normal

◆ SetPosition()

virtual void SimplygonSDK::IScenePlane::SetPosition ( const real vec_realInputDataPtr)
pure virtual

Set the position (translation) of the plane

Parameters
vec_realInputDataPtrthe new position

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