class SceneCamera

SceneCamera is the camera node in the Simplygon scene graph. SceneCamera contains settings that specify how the camera works and it contains a number of views for that type of camera. A view is a combination of a CameraPosition and a TargetPosition. The SceneCamera can contain any number of views but every element in TargetPositions has to correspond to a tuple element in CameraPosition. TargetPositions is not needed if the camera is set to being omni directional.

Properties

Property	Description
CameraType	The camera type. Perspective - A regular camera that uses the FieldOfView. Omnidirectional - An omni directional camera view all directions from its position and ignores the TargetPositions and FieldOfView. Orthographic - Orthographic cameras render the scene in a direction determined by the vector from CameraPositions to TargetPositions, it uses OrthographicCameraPixelSize and ignores the FieldOfView and UseNormalizedCoordinates.
FieldOfView	The field of view (in radians) of the camera.
IsFrozen	The IsFrozen flag. If set, the node will not be modified by processing modules. (Inherited from SceneNode)
IsModified	If set, the node is new, copied, or modified by processing modules. This can be useful to track modifications in the scene graph. (Inherited from SceneNode)
IsVisible	The IsVisible flag. If set, the node is visible. (Inherited from SceneNode)
Name	The name of the SceneCamera object. (Inherited from Object)
NodeGUID	The unique id for this node. (Inherited from SceneNode)
OriginalName	The OriginalName parameter which can be used to specify the original name of a node, for debugging of merging purposes. This parameter is not copied or cloned, and is not used internally by Simplygon. (Inherited from SceneNode)
OrthographicCameraPixelSize	Specifies/Gets the length of the side of a square pixel if the camera type is Orthographic.
PixelFieldOfView	Determines the resolution by specifying the field of view per pixel (both vertically and horizontally) if the camera type is Perspective or Omnidirectional. For instance, if the camera type is Perspective and has PI/2 radians field of view (for the entire camera) and the pixel field of view is (PI/2)/512 the camera will have 512x512 pixels.
UseNormalizedCoordinates	Normalized coordinates means that the coordinates are relative to the scene: the origin is in the center of the scene and 1 unit length is the distance of the scene radius. This can be used to have cameras in front of or above the scene for instance without having to know the coordinates of the scene. If set to false, then absolute coordinates will be used instead.

Methods

Method	Description
AddChild	Adds a child node to this node. If the child is already a child of another node, it is removed from this node. (Inherited from SceneNode)
AddObserver	Adds a user-defined observer object to the interface, that will receive events from the interface. (Inherited from Object)
CalculateExtents	Calculates the axis-aligned bounding box of the node and all its children. If the node tree contains no geometric data, or all data is hidden, the bounding box is not calculated, and the method returns false. (Inherited from SceneNode)
CreateChildMesh	Creates a SceneMesh node as a child node to this node. (Inherited from SceneNode)
CreateChildPlane	Creates a ScenePlane node as a child node to this node. (Inherited from SceneNode)
EvaluateDefaultGlobalTransformation	Evaluates the default global transformation of the node, regardless of node animation. (Inherited from SceneNode)
FindNamedChild	Finds the first child that has the name. (Inherited from SceneNode)
GetCameraPositions	CameraPositions is an IRealArray (with tuple size 3) where each tuple is a 3d camera position.
GetChild	Get a pointer to the i:th child of this node. (Inherited from SceneNode)
GetChildCount	The number of direct children of this node. (Inherited from SceneNode)
GetClass	Get the name of the SceneCamera class. (Inherited from Object)
GetInf	The inferior (minimum) extent of the node. (Inherited from SceneNode)
GetNumberOfViews	Returns the number of views.
GetParent	The parent node of this node. (Inherited from SceneNode)
GetPath	The path to this node in the scene. Please note that only paths where each node has a name can be used to get to the node using the path. (Inherited from SceneNode)
GetRelativeTransform	The relative transformation of this node. (Inherited from SceneNode)
GetScene	The scene object of the node. (Inherited from SceneNode)
GetSup	The superior (maximum) extent of the node. (Inherited from SceneNode)
GetTargetPositions	TargetPositions is an IRealArray (with tuple size 3) where each tuple is a 3d camera target position.
HasChild	Returns true if the node has the specified child. (Inherited from SceneNode)
IsA	Returns true if SceneCamera is a or is a descendant of the class named as the type parameter. (Inherited from Object)
IsNull	Returns true if the SceneCamera object is invalid. (Inherited from Object)
IsSameObjectAs	Returns true if the SceneCamera object is valid. (Inherited from Object)
NewClone	See NewCopy (Inherited from SceneNode)
NewCopy	Deep copies this node tree (this node and all the descendants of this node) and returns the copy top node. Please note that the copy is not added to any scene, and can be added anywhere. Also note that the clone shares all data pointers with the original nodes, such as geometry data objects. (Inherited from SceneNode)
NonNull	Returns true if the SceneCamera object is valid. (Inherited from Object)
PrintInfo	Prints the content/info of the SceneCamera object to the log. (Inherited from Object)
RemoveChild	Removes a child from the node. (Inherited from SceneNode)
RemoveChildren	Removes all children of this node. (Inherited from SceneNode)
RemoveFromParent	Removes this node from its parent. (Inherited from SceneNode)
RemoveObserver	Removes a previously added observer object. (Inherited from Object)
SetCustomSphereCameraPath	Creates a set of camera views placed on a custom sphere around the center of the scene.
ValidateCamera	Validates the camera properties. Asserts on invalid properties.

Static methods

Method	Description
IsClassA	Returns true if the class is a or is a descendant of the class named as the type parameter. (Inherited from Object)
SafeCast	SafeCast makes sure the input object is of a class that can be cast into spSceneCamera, and if this is the case, returns the object cast into spSceneCamera. (Inherited from Object)

Properties details

CameraType

The camera type. Perspective - A regular camera that uses the FieldOfView. Omnidirectional - An omni directional camera view all directions from its position and ignores the TargetPositions and FieldOfView. Orthographic - Orthographic cameras render the scene in a direction determined by the vector from CameraPositions to TargetPositions, it uses OrthographicCameraPixelSize and ignores the FieldOfView and UseNormalizedCoordinates.

Syntax

// Setter
void SetCameraType( Simplygon::ECameraType value ) const;

// Getter
Simplygon::ECameraType GetCameraType() const;

SetCameraType parameters

Type	Name	Min	Max	Description
ECameraType	value			The desired CameraType.

GetCameraType return value

Type: ECameraType

Default: Perspective

Key	Value	Comment
Perspective	0	Perspective cameras have a field of view.
Orthographic	1	Orthographic cameras have a size.
Omnidirectional	2	Omnidirectional cameras view all directions.

Syntax

// Setter
void SetCameraType(ECameraType value);

// Getter
ECameraType GetCameraType();

SetCameraType parameters

Type	Name	Min	Max	Description
ECameraType	value			The desired CameraType.

GetCameraType return value

Type: ECameraType

Default: Perspective

Key	Value	Comment
Perspective	0	Perspective cameras have a field of view.
Orthographic	1	Orthographic cameras have a size.
Omnidirectional	2	Omnidirectional cameras view all directions.

Syntax

# Setter
None SetCameraType(value: ECameraType_*)

# Getter
ECameraType_* GetCameraType()

SetCameraType parameters

Name	Type	Min	Max	Description
value	ECameraType			The desired CameraType.

GetCameraType return value

Type: ECameraType

Default: Perspective

Key	Value	Comment
ECameraType_Perspective	0	Perspective cameras have a field of view.
ECameraType_Orthographic	1	Orthographic cameras have a size.
ECameraType_Omnidirectional	2	Omnidirectional cameras view all directions.

FieldOfView

The field of view (in radians) of the camera.

Syntax

// Setter
void SetFieldOfView( real value ) const;

// Getter
real GetFieldOfView() const;

SetFieldOfView parameters

Type	Name	Min	Max	Description
real	value			The desired FieldOfView value.

GetFieldOfView return value

Type: real

Syntax

// Setter
void SetFieldOfView(float value);

// Getter
float GetFieldOfView();

SetFieldOfView parameters

Type	Name	Min	Max	Description
float	value			The desired FieldOfView value.

GetFieldOfView return value

Type: float

Syntax

# Setter
None SetFieldOfView(value: float)

# Getter
float GetFieldOfView()

SetFieldOfView parameters

Name	Type	Min	Max	Description
value	float			The desired FieldOfView value.

GetFieldOfView return value

Type: float

IsFrozen

The IsFrozen flag. If set, the node will not be modified by processing modules.

Syntax

// Setter
void SetIsFrozen( bool value ) const;

// Getter
bool GetIsFrozen() const;

SetIsFrozen parameters

Type	Name	Min	Max	Description
bool	value			The bool that isFrozen is to be set to.

GetIsFrozen return value

Type: bool

Syntax

// Setter
void SetIsFrozen(bool value);

// Getter
bool GetIsFrozen();

SetIsFrozen parameters

Type	Name	Min	Max	Description
bool	value			The bool that isFrozen is to be set to.

GetIsFrozen return value

Type: bool

Syntax

# Setter
None SetIsFrozen(value: bool)

# Getter
bool GetIsFrozen()

SetIsFrozen parameters

Name	Type	Min	Max	Description
value	bool			The bool that isFrozen is to be set to.

GetIsFrozen return value

Type: bool

IsModified

If set, the node is new, copied, or modified by processing modules. This can be useful to track modifications in the scene graph.

Syntax

// Setter
void SetIsModified( bool value ) const;

// Getter
bool GetIsModified() const;

SetIsModified parameters

Type	Name	Min	Max	Description
bool	value			The bool that IsModified is to be set to.

GetIsModified return value

Type: bool

Syntax

// Setter
void SetIsModified(bool value);

// Getter
bool GetIsModified();

SetIsModified parameters

Type	Name	Min	Max	Description
bool	value			The bool that IsModified is to be set to.

GetIsModified return value

Type: bool

Syntax

# Setter
None SetIsModified(value: bool)

# Getter
bool GetIsModified()

SetIsModified parameters

Name	Type	Min	Max	Description
value	bool			The bool that IsModified is to be set to.

GetIsModified return value

Type: bool

IsVisible

The IsVisible flag. If set, the node is visible.

Syntax

// Setter
void SetIsVisible( bool value ) const;

// Getter
bool GetIsVisible() const;

SetIsVisible parameters

Type	Name	Min	Max	Description
bool	value			The bool that isVisible is to be set to.

GetIsVisible return value

Type: bool

Syntax

// Setter
void SetIsVisible(bool value);

// Getter
bool GetIsVisible();

SetIsVisible parameters

Type	Name	Min	Max	Description
bool	value			The bool that isVisible is to be set to.

GetIsVisible return value

Type: bool

Syntax

# Setter
None SetIsVisible(value: bool)

# Getter
bool GetIsVisible()

SetIsVisible parameters

Name	Type	Min	Max	Description
value	bool			The bool that isVisible is to be set to.

GetIsVisible return value

Type: bool

Name

The name of the SceneCamera object. (Inherited from Object)

Syntax

// Setter
void SetName( const char * name ) const;

// Getter
spString GetName() const;

SetName parameters

Type	Name	Min	Max	Description
const char *	name			New name of the object.

GetName return value

Type: spString

Syntax

// Setter
void SetName(string name);

// Getter
string GetName();

SetName parameters

Type	Name	Min	Max	Description
string	name			New name of the object.

GetName return value

Type: string

Syntax

# Setter
None SetName(name: str)

# Getter
str GetName()

SetName parameters

Name	Type	Min	Max	Description
name	str			New name of the object.

GetName return value

Type: str

NodeGUID

The unique id for this node.

Syntax

// Setter
void SetNodeGUID( const char * value ) const;

// Getter
spString GetNodeGUID() const;

SetNodeGUID parameters

Type	Name	Min	Max	Description
const char *	value			The node id of type string.

GetNodeGUID return value

Type: spString

Syntax

// Setter
void SetNodeGUID(string value);

// Getter
string GetNodeGUID();

SetNodeGUID parameters

Type	Name	Min	Max	Description
string	value			The node id of type string.

GetNodeGUID return value

Type: string

Syntax

# Setter
None SetNodeGUID(value: str)

# Getter
str GetNodeGUID()

SetNodeGUID parameters

Name	Type	Min	Max	Description
value	str			The node id of type string.

GetNodeGUID return value

Type: str

OriginalName

The OriginalName parameter which can be used to specify the original name of a node, for debugging of merging purposes. This parameter is not copied or cloned, and is not used internally by Simplygon.

Syntax

// Setter
void SetOriginalName( const char * value ) const;

// Getter
spString GetOriginalName() const;

SetOriginalName parameters

Type	Name	Min	Max	Description
const char *	value			Is a string the name is to be set to.

GetOriginalName return value

Type: spString

Syntax

// Setter
void SetOriginalName(string value);

// Getter
string GetOriginalName();

SetOriginalName parameters

Type	Name	Min	Max	Description
string	value			Is a string the name is to be set to.

GetOriginalName return value

Type: string

Syntax

# Setter
None SetOriginalName(value: str)

# Getter
str GetOriginalName()

SetOriginalName parameters

Name	Type	Min	Max	Description
value	str			Is a string the name is to be set to.

GetOriginalName return value

Type: str

OrthographicCameraPixelSize

Specifies/Gets the length of the side of a square pixel if the camera type is Orthographic.

Syntax

// Setter
void SetOrthographicCameraPixelSize( real value ) const;

// Getter
real GetOrthographicCameraPixelSize() const;

SetOrthographicCameraPixelSize parameters

Type	Name	Min	Max	Description
real	value			The desired OrthographicCameraPixelSize value.

GetOrthographicCameraPixelSize return value

Type: real

Syntax

// Setter
void SetOrthographicCameraPixelSize(float value);

// Getter
float GetOrthographicCameraPixelSize();

SetOrthographicCameraPixelSize parameters

Type	Name	Min	Max	Description
float	value			The desired OrthographicCameraPixelSize value.

GetOrthographicCameraPixelSize return value

Type: float

Syntax

# Setter
None SetOrthographicCameraPixelSize(value: float)

# Getter
float GetOrthographicCameraPixelSize()

SetOrthographicCameraPixelSize parameters

Name	Type	Min	Max	Description
value	float			The desired OrthographicCameraPixelSize value.

GetOrthographicCameraPixelSize return value

Type: float

PixelFieldOfView

Determines the resolution by specifying the field of view per pixel (both vertically and horizontally) if the camera type is Perspective or Omnidirectional. For instance, if the camera type is Perspective and has PI/2 radians field of view (for the entire camera) and the pixel field of view is (PI/2)/512 the camera will have 512x512 pixels.

Syntax

// Setter
void SetPixelFieldOfView( real value ) const;

// Getter
real GetPixelFieldOfView() const;

SetPixelFieldOfView parameters

Type	Name	Min	Max	Description
real	value			The desired PixelFieldOfView value.

GetPixelFieldOfView return value

Type: real

Syntax

// Setter
void SetPixelFieldOfView(float value);

// Getter
float GetPixelFieldOfView();

SetPixelFieldOfView parameters

Type	Name	Min	Max	Description
float	value			The desired PixelFieldOfView value.

GetPixelFieldOfView return value

Type: float

Syntax

# Setter
None SetPixelFieldOfView(value: float)

# Getter
float GetPixelFieldOfView()

SetPixelFieldOfView parameters

Name	Type	Min	Max	Description
value	float			The desired PixelFieldOfView value.

GetPixelFieldOfView return value

Type: float

UseNormalizedCoordinates

Normalized coordinates means that the coordinates are relative to the scene: the origin is in the center of the scene and 1 unit length is the distance of the scene radius. This can be used to have cameras in front of or above the scene for instance without having to know the coordinates of the scene. If set to false, then absolute coordinates will be used instead.

Syntax

// Setter
void SetUseNormalizedCoordinates( bool value ) const;

// Getter
bool GetUseNormalizedCoordinates() const;

SetUseNormalizedCoordinates parameters

Type	Name	Min	Max	Description
bool	value			The desired UseNormalizedCoordinates flag.

GetUseNormalizedCoordinates return value

Type: bool

Syntax

// Setter
void SetUseNormalizedCoordinates(bool value);

// Getter
bool GetUseNormalizedCoordinates();

SetUseNormalizedCoordinates parameters

Type	Name	Min	Max	Description
bool	value			The desired UseNormalizedCoordinates flag.

GetUseNormalizedCoordinates return value

Type: bool

Syntax

# Setter
None SetUseNormalizedCoordinates(value: bool)

# Getter
bool GetUseNormalizedCoordinates()

SetUseNormalizedCoordinates parameters

Name	Type	Min	Max	Description
value	bool			The desired UseNormalizedCoordinates flag.

GetUseNormalizedCoordinates return value

Type: bool

Methods details

AddChild

Adds a child node to this node. If the child is already a child of another node, it is removed from this node.

Syntax

void AddChild( const spSceneNode & child ) const;

Parameters

Type	Name	Min	Max	Description
SceneNode	child			The child object.

Syntax

void AddChild(spSceneNode child);

Parameters

Type	Name	Min	Max	Description
SceneNode	child			The child object.

Syntax

None AddChild(child: spSceneNode)

Parameters

Name	Type	Min	Max	Description
child	SceneNode			The child object.

AddObserver

Adds a user-defined observer object to the interface, that will receive events from the interface. (Inherited from Object)

Syntax

rid AddObserver( const spObserver & observer ) const;

Parameters

Type	Name	Min	Max	Description
Observer	observer			Observer is the object that will receive events.

Return value

Type: rid

Syntax

int AddObserver(spObserver observer);

Parameters

Type	Name	Min	Max	Description
Observer	observer			Observer is the object that will receive events.

Return value

Type: int

Syntax

int AddObserver(observer: spObserver)

Parameters

Name	Type	Min	Max	Description
observer	Observer			Observer is the object that will receive events.

Return value

Type: int

CalculateExtents

Calculates the axis-aligned bounding box of the node and all its children. If the node tree contains no geometric data, or all data is hidden, the bounding box is not calculated, and the method returns false.

Syntax

bool CalculateExtents() const;

Parameters

CalculateExtents takes no parameters.

Return value

Type: bool

Syntax

bool CalculateExtents();

Parameters

CalculateExtents takes no parameters.

Return value

Type: bool

Syntax

bool CalculateExtents()

Parameters

CalculateExtents takes no parameters.

Return value

Type: bool

CreateChildMesh

Creates a SceneMesh node as a child node to this node.

Syntax

spSceneMesh CreateChildMesh( const spGeometryData & geom ) const;

Parameters

Type	Name	Min	Max	Description
GeometryData	geom			The GeometryData object to associate with this node.

Return value

Type: SceneMesh

Syntax

spSceneMesh CreateChildMesh(spGeometryData geom);

Parameters

Type	Name	Min	Max	Description
GeometryData	geom			The GeometryData object to associate with this node.

Return value

Type: SceneMesh

Syntax

spSceneMesh CreateChildMesh(geom: spGeometryData)

Parameters

Name	Type	Min	Max	Description
geom	GeometryData			The GeometryData object to associate with this node.

Return value

Type: SceneMesh

CreateChildPlane

Creates a ScenePlane node as a child node to this node.

Syntax

spScenePlane CreateChildPlane( const real *position_realInputDataPtr , const real *normal_realInputDataPtr ) const;

Parameters

Type	Name	Min	Max	Description
RealData	position			The point on the plane.
RealData	normal			The normal to the plane.

Return value

Type: ScenePlane

Syntax

spScenePlane CreateChildPlane(float[] position, float[] normal);

Parameters

Type	Name	Min	Max	Description
float[]	position			The point on the plane.
float[]	normal			The normal to the plane.

Return value

Type: ScenePlane

Syntax

spScenePlane CreateChildPlane(position: float, normal: float)

Parameters

Name	Type	Min	Max	Description
position	float			The point on the plane.
normal	float			The normal to the plane.

Return value

Type: ScenePlane

EvaluateDefaultGlobalTransformation

Evaluates the default global transformation of the node, regardless of node animation.

Syntax

void EvaluateDefaultGlobalTransformation( const spMatrix4x4 & global_transform ) const;

Parameters

Type	Name	Min	Max	Description
Matrix4x4	global_transform			The transformation matrix that receives the global transformation.

Syntax

void EvaluateDefaultGlobalTransformation(spMatrix4x4 global_transform);

Parameters

Type	Name	Min	Max	Description
Matrix4x4	global_transform			The transformation matrix that receives the global transformation.

Syntax

None EvaluateDefaultGlobalTransformation(global_transform: spMatrix4x4)

Parameters

Name	Type	Min	Max	Description
global_transform	Matrix4x4			The transformation matrix that receives the global transformation.

FindNamedChild

Finds the first child that has the name.

Syntax

spSceneNode FindNamedChild( const char * name ) const;

Parameters

Type	Name	Min	Max	Description
const char *	name			The name of the child to look for.

Return value

Type: SceneNode

Syntax

spSceneNode FindNamedChild(string name);

Parameters

Type	Name	Min	Max	Description
string	name			The name of the child to look for.

Return value

Type: SceneNode

Syntax

spSceneNode FindNamedChild(name: str)

Parameters

Name	Type	Min	Max	Description
name	str			The name of the child to look for.

Return value

Type: SceneNode

GetCameraPositions

CameraPositions is an IRealArray (with tuple size 3) where each tuple is a 3d camera position.

Syntax

spRealArray GetCameraPositions() const;

Parameters

GetCameraPositions takes no parameters.

Return value

Type: RealArray

Syntax

spRealArray GetCameraPositions();

Parameters

GetCameraPositions takes no parameters.

Return value

Type: RealArray

Syntax

spRealArray GetCameraPositions()

Parameters

GetCameraPositions takes no parameters.

Return value

Type: RealArray

GetChild

Get a pointer to the i:th child of this node.

Syntax

spSceneNode GetChild( rid index ) const;

Parameters

Type	Name	Min	Max	Description
rid	index			The local index of the child (0->GetChildCount()-1)

Return value

Type: SceneNode

Syntax

spSceneNode GetChild(int index);

Parameters

Type	Name	Min	Max	Description
int	index			The local index of the child (0->GetChildCount()-1)

Return value

Type: SceneNode

Syntax

spSceneNode GetChild(index: int)

Parameters

Name	Type	Min	Max	Description
index	int			The local index of the child (0->GetChildCount()-1)

Return value

Type: SceneNode

GetChildCount

The number of direct children of this node.

Syntax

unsigned int GetChildCount() const;

Parameters

GetChildCount takes no parameters.

Return value

Type: unsigned int

Syntax

uint GetChildCount();

Parameters

GetChildCount takes no parameters.

Return value

Type: uint

Syntax

int GetChildCount()

Parameters

GetChildCount takes no parameters.

Return value

Type: int

GetClass

Get the name of the SceneCamera class. (Inherited from Object)

Syntax

spString GetClass() const;

Parameters

GetClass takes no parameters.

Return value

Type: spString

Syntax

string GetClass();

Parameters

GetClass takes no parameters.

Return value

Type: string

Syntax

str GetClass()

Parameters

GetClass takes no parameters.

Return value

Type: str

GetInf

The inferior (minimum) extent of the node.

Syntax

spRealData GetInf() const;

Parameters

GetInf takes no parameters.

Return value

Type: spRealData

Syntax

spRealData GetInf();

Parameters

GetInf takes no parameters.

Return value

Type: spRealData

Syntax

spRealData GetInf()

Parameters

GetInf takes no parameters.

Return value

Type: list[float]

GetNumberOfViews

Returns the number of views.

Syntax

unsigned int GetNumberOfViews() const;

Parameters

GetNumberOfViews takes no parameters.

Return value

Type: unsigned int

Syntax

uint GetNumberOfViews();

Parameters

GetNumberOfViews takes no parameters.

Return value

Type: uint

Syntax

int GetNumberOfViews()

Parameters

GetNumberOfViews takes no parameters.

Return value

Type: int

GetParent

The parent node of this node.

Syntax

spSceneNode GetParent() const;

Parameters

GetParent takes no parameters.

Return value

Type: SceneNode

Syntax

spSceneNode GetParent();

Parameters

GetParent takes no parameters.

Return value

Type: SceneNode

Syntax

spSceneNode GetParent()

Parameters

GetParent takes no parameters.

Return value

Type: SceneNode

GetPath

The path to this node in the scene. Please note that only paths where each node has a name can be used to get to the node using the path.

Syntax

spString GetPath() const;

Parameters

GetPath takes no parameters.

Return value

Type: spString

Syntax

string GetPath();

Parameters

GetPath takes no parameters.

Return value

Type: string

Syntax

str GetPath()

Parameters

GetPath takes no parameters.

Return value

Type: str

GetRelativeTransform

The relative transformation of this node.

Syntax

spMatrix4x4 GetRelativeTransform() const;

Parameters

GetRelativeTransform takes no parameters.

Return value

Type: Matrix4x4

Syntax

spMatrix4x4 GetRelativeTransform();

Parameters

GetRelativeTransform takes no parameters.

Return value

Type: Matrix4x4

Syntax

spMatrix4x4 GetRelativeTransform()

Parameters

GetRelativeTransform takes no parameters.

Return value

Type: Matrix4x4

GetScene

The scene object of the node.

Syntax

spScene GetScene() const;

Parameters

GetScene takes no parameters.

Return value

Type: Scene

Syntax

spScene GetScene();

Parameters

GetScene takes no parameters.

Return value

Type: Scene

Syntax

spScene GetScene()

Parameters

GetScene takes no parameters.

Return value

Type: Scene

GetSup

The superior (maximum) extent of the node.

Syntax

spRealData GetSup() const;

Parameters

GetSup takes no parameters.

Return value

Type: spRealData

Syntax

spRealData GetSup();

Parameters

GetSup takes no parameters.

Return value

Type: spRealData

Syntax

spRealData GetSup()

Parameters

GetSup takes no parameters.

Return value

Type: list[float]

GetTargetPositions

TargetPositions is an IRealArray (with tuple size 3) where each tuple is a 3d camera target position.

Syntax

spRealArray GetTargetPositions() const;

Parameters

GetTargetPositions takes no parameters.

Return value

Type: RealArray

Syntax

spRealArray GetTargetPositions();

Parameters

GetTargetPositions takes no parameters.

Return value

Type: RealArray

Syntax

spRealArray GetTargetPositions()

Parameters

GetTargetPositions takes no parameters.

Return value

Type: RealArray

HasChild

Returns true if the node has the specified child.

Syntax

bool HasChild( const spSceneNode & child ) const;

Parameters

Type	Name	Min	Max	Description
SceneNode	child			The child node to look for.

Return value

Type: bool

Syntax

bool HasChild(spSceneNode child);

Parameters

Type	Name	Min	Max	Description
SceneNode	child			The child node to look for.

Return value

Type: bool

Syntax

bool HasChild(child: spSceneNode)

Parameters

Name	Type	Min	Max	Description
child	SceneNode			The child node to look for.

Return value

Type: bool

IsA

Returns true if SceneCamera is a or is a descendant of the class named as the type parameter. (Inherited from Object)

Syntax

bool IsA( const char * type ) const;

Parameters

Type	Name	Min	Max	Description
const char *	type			Name of the class to check if SceneCamera is, or is a descendant of.

Return value

Type: bool

Syntax

bool IsA(string type);

Parameters

Type	Name	Min	Max	Description
string	type			Name of the class to check if SceneCamera is, or is a descendant of.

Return value

Type: bool

Syntax

bool IsA(type: str)

Parameters

Name	Type	Min	Max	Description
type	str			Name of the class to check if SceneCamera is, or is a descendant of.

Return value

Type: bool

IsNull

Returns true if the SceneCamera object is invalid. (Inherited from Object)

Syntax

bool IsNull() const;

Parameters

IsNull takes no parameters.

Return value

Type: bool

Syntax

bool IsNull();

Parameters

IsNull takes no parameters.

Return value

Type: bool

Syntax

bool IsNull()

Parameters

IsNull takes no parameters.

Return value

Type: bool

IsSameObjectAs

Returns true if the SceneCamera object is valid. (Inherited from Object)

Syntax

bool IsSameObjectAs( const spObject & object ) const;

Parameters

Type	Name	Min	Max	Description
Object	object			Object to compare with.

Return value

Type: bool

Syntax

bool IsSameObjectAs(spObject object);

Parameters

Type	Name	Min	Max	Description
Object	object			Object to compare with.

Return value

Type: bool

Syntax

bool IsSameObjectAs(object: spObject)

Parameters

Name	Type	Min	Max	Description
object	Object			Object to compare with.

Return value

Type: bool

NewClone

See NewCopy

WARNING

This method is marked as deprecated and will be removed in a future version.

Use NewCopy instead.

Syntax

SGDEPRECATED spSceneNode NewClone() const;

Parameters

NewClone takes no parameters.

Return value

Type: SceneNode

Syntax

spSceneNode NewClone();

Parameters

NewClone takes no parameters.

Return value

Type: SceneNode

Syntax

spSceneNode NewClone()

Parameters

NewClone takes no parameters.

Return value

Type: SceneNode

NewCopy

Deep copies this node tree (this node and all the descendants of this node) and returns the copy top node. Please note that the copy is not added to any scene, and can be added anywhere. Also note that the clone shares all data pointers with the original nodes, such as geometry data objects.

Syntax

spSceneNode NewCopy() const;

Parameters

NewCopy takes no parameters.

Return value

Type: SceneNode

Syntax

spSceneNode NewCopy();

Parameters

NewCopy takes no parameters.

Return value

Type: SceneNode

Syntax

spSceneNode NewCopy()

Parameters

NewCopy takes no parameters.

Return value

Type: SceneNode

NonNull

Returns true if the SceneCamera object is valid. (Inherited from Object)

Syntax

bool NonNull() const;

Parameters

NonNull takes no parameters.

Return value

Type: bool

Syntax

bool NonNull();

Parameters

NonNull takes no parameters.

Return value

Type: bool

Syntax

bool NonNull()

Parameters

NonNull takes no parameters.

Return value

Type: bool

PrintInfo

Prints the content/info of the SceneCamera object to the log. (Inherited from Object)

Syntax

void PrintInfo() const;

Parameters

PrintInfo takes no parameters.

Syntax

void PrintInfo();

Parameters

PrintInfo takes no parameters.

Syntax

None PrintInfo()

Parameters

PrintInfo takes no parameters.

RemoveChild

Removes a child from the node.

Syntax

void RemoveChild( const spSceneNode & child ) const;

Parameters

Type	Name	Min	Max	Description
SceneNode	child			The child to be removed.

Syntax

void RemoveChild(spSceneNode child);

Parameters

Type	Name	Min	Max	Description
SceneNode	child			The child to be removed.

Syntax

None RemoveChild(child: spSceneNode)

Parameters

Name	Type	Min	Max	Description
child	SceneNode			The child to be removed.

RemoveChildren

Removes all children of this node.

Syntax

void RemoveChildren() const;

Parameters

RemoveChildren takes no parameters.

Syntax

void RemoveChildren();

Parameters

RemoveChildren takes no parameters.

Syntax

None RemoveChildren()

Parameters

RemoveChildren takes no parameters.

RemoveFromParent

Removes this node from its parent.

Syntax

void RemoveFromParent() const;

Parameters

RemoveFromParent takes no parameters.

Syntax

void RemoveFromParent();

Parameters

RemoveFromParent takes no parameters.

Syntax

None RemoveFromParent()

Parameters

RemoveFromParent takes no parameters.

RemoveObserver

Removes a previously added observer object. (Inherited from Object)

Syntax

void RemoveObserver( rid observerId ) const;

Parameters

Type	Name	Min	Max	Description
rid	observerId			ObserverId is the id returned by AddObserver when the observer was added.

Syntax

void RemoveObserver(int observerId);

Parameters

Type	Name	Min	Max	Description
int	observerId			ObserverId is the id returned by AddObserver when the observer was added.

Syntax

None RemoveObserver(observerId: int)

Parameters

Name	Type	Min	Max	Description
observerId	int			ObserverId is the id returned by AddObserver when the observer was added.

SetCustomSphereCameraPath

Creates a set of camera views placed on a custom sphere around the center of the scene.

Syntax

void SetCustomSphereCameraPath( int fidelity , real pitch_angle , real yaw_angle , real coverage_angle ) const;

Parameters

Type	Name	Min	Max	Description
int	fidelity			Determines both the resolution and the amount of cameras and should be between 0 and 10.
real	pitch_angle			Amount of degrees the sphere should be pitch rotated.
real	yaw_angle			Amount of degrees the sphere should be yaw rotated.
real	coverage_angle			360 would be entire sphere, 180 would be hemisphere, 0 would be no sphere.

Syntax

void SetCustomSphereCameraPath(int fidelity, float pitch_angle, float yaw_angle, float coverage_angle);

Parameters

Type	Name	Min	Max	Description
int	fidelity			Determines both the resolution and the amount of cameras and should be between 0 and 10.
float	pitch_angle			Amount of degrees the sphere should be pitch rotated.
float	yaw_angle			Amount of degrees the sphere should be yaw rotated.
float	coverage_angle			360 would be entire sphere, 180 would be hemisphere, 0 would be no sphere.

Syntax

None SetCustomSphereCameraPath(fidelity: int, pitch_angle: float, yaw_angle: float, coverage_angle: float)

Parameters

Name	Type	Min	Max	Description
fidelity	int			Determines both the resolution and the amount of cameras and should be between 0 and 10.
pitch_angle	float			Amount of degrees the sphere should be pitch rotated.
yaw_angle	float			Amount of degrees the sphere should be yaw rotated.
coverage_angle	float			360 would be entire sphere, 180 would be hemisphere, 0 would be no sphere.

ValidateCamera

Validates the camera properties. Asserts on invalid properties.

Syntax

bool ValidateCamera() const;

Parameters

ValidateCamera takes no parameters.

Return value

Type: bool

Syntax

bool ValidateCamera();

Parameters

ValidateCamera takes no parameters.

Return value

Type: bool

Syntax

bool ValidateCamera()

Parameters

ValidateCamera takes no parameters.

Return value

Type: bool

Static methods details

IsClassA

Returns true if the class is a or is a descendant of the class named as the type parameter. (Inherited from Object)

Syntax

static bool IsClassA( const char * type ) const;

Parameters

Type	Name	Min	Max	Description
const char *	type			Name of the class to check if the class is, or is a descendant of.

Return value

Type: bool

Syntax

static bool IsClassA(string type);

Parameters

Type	Name	Min	Max	Description
string	type			Name of the class to check if the class is, or is a descendant of.

Return value

Type: bool

Syntax

@staticmethod
bool IsClassA(type: str)

Parameters

Name	Type	Min	Max	Description
type	str			Name of the class to check if the class is, or is a descendant of.

Return value

Type: bool

SafeCast

SafeCast makes sure the input object is of a class that can be cast into spSceneCamera, and if this is the case, returns the object cast into spSceneCamera. (Inherited from Object)

Syntax

static spSceneCamera SafeCast( const spObject & object ) const;

Parameters

Type	Name	Min	Max	Description
Object	object			Object to cast.

Return value

Type: SceneCamera

Syntax

static spSceneCamera SafeCast(spObject object);

Parameters

Type	Name	Min	Max	Description
Object	object			Object to cast.

Return value

Type: SceneCamera

Syntax

@staticmethod
spSceneCamera SafeCast(object: spObject)

Parameters

Name	Type	Min	Max	Description
object	Object			Object to cast.

Return value

Type: SceneCamera