SViewSet Class Reference

Allow to save the camera position, the visibility of objects and their representation mode in a 3D scene. More...

Inheritance diagram for SViewSet:

Public Member Functions
	SViewSet ()
	Default constructor.
	SViewSet (boolean saveObjectsVisibility=true)
	Default constructor to create an SViewSet.
	SViewSet (SViewSet other)
	Construct an SViewSet by copying other.
string	toString ()
	Get the type of the variable.
	Update (boolean saveObjectsVisibility)
	Update the SViewSet with the current position of the camera.
Public Member Functions inherited from SComp
	AddToDoc ()
	Add the object to the document.
	ApplyTransformation (SMatrix matrix)
	Apply a geometric transformation to the current object by making a product with the given matrix.
Object	GetBoundingBox (SMatrix ucs=null)
	Calculate the bounding box of the object.
Object	GetColors ()
	Get the colors of the object.
string	GetFolderName ()
	Get the name of the folder containing the object.
string	GetName ()
	Return the object's name.
string	GetPath ()
	Return the full path of an SComp in the tree.
	Invert ()
	Invert the normal of the object.
boolean	IsInDoc ()
	Return if the object is in the document or not.
boolean	IsVisible ()
	Get the visibility of the object.
	MoveToGroup (string groupPath, boolean moveInsideTopParent=true)
	Move the object to the document group represent by the given path. If some groups, in the path, don't exist, they will be created.
	RemoveFromDoc ()
	Remove the object from the document.
	SetClippable (boolean clipping)
	Set clippable or not.
	SetColors (number red, number green, number blue)
	Set the colors of the object.
	SetName (string objectName)
	Set the object's name.
	SetTransparency (number alpha)
	Set the transparency of the object.
	SetVisibility (boolean visible)
	Set the object to be visible, or not visible.
string	toString ()
	Get the type of the variable.
	Translate (SVector vector)
	Make a translation of the current object with an SVector.

Static Public Member Functions
static Array< SViewSet >	All (VisibilityEnum visCrit=SComp.ANY_VISIBILITY)
	Get all the SViewSet in the document.
static Array< SViewSet >	FromName (string name)
	Search all the SViewSet with the given name.
static Array< SViewSet >	FromSel ()
	Get all the selected SViewSet.
static SViewSet	New (boolean saveObjectsVisibility=true)
	Default constructor to create an SViewSet.
static SViewSet	New (SViewSet other)
	Construct an SViewSet by copying other.
Static Public Member Functions inherited from SComp
static Array< SComp >	All (VisibilityEnum visCrit=SComp.ANY_VISIBILITY)
	Get all the SComp in the document.
static Object	FromClick ()
	Launch an interaction to select a SComp in the scene.
static Array< SComp >	FromName (string name)
	Search all the SComp with the given name.
static Array< SComp >	FromSel ()
	Get all the selected SComp.

Additional Inherited Members
Public Types inherited from SComp
enum	VisibilityEnum { HIDDEN_ONLY = 0 , VISIBLE_ONLY = 1 , ANY_VISIBILITY = 2 }
	Visible criteria. More...

Detailed Description

Allow to save the camera position, the visibility of objects and their representation mode in a 3D scene.

Constructor & Destructor Documentation

SViewSet() [1/3]

SViewSet::SViewSet

(

)

Default constructor.

SViewSet() [2/3]

SViewSet::SViewSet

(

boolean

saveObjectsVisibility = true

)

Default constructor to create an SViewSet.

Parameters

saveObjectsVisibility

(boolean) If true, save the objects visibility and representation mode

SViewSet() [3/3]

SViewSet::SViewSet

(

SViewSet

other

)

Construct an SViewSet by copying other.

Parameters

other

(SViewSet) The other SViewSet to copy

Member Function Documentation

All()

static Array< SViewSet > SViewSet::All ( VisibilityEnum visCrit = SComp.ANY_VISIBILITY )

static

Get all the SViewSet in the document.

Parameters

visCrit

(VisibilityEnum) Visible selection criteria SComp.HIDDEN_ONLY: Keep if not visible SComp.VISIBLE_ONLY: Keep if visible SComp.ANY_VISIBILITY: Indifferent

Returns

(Array<SViewSet>) Array of all the SViewSet contained in the document, that fulfill the visibility criteria

FromName()

static Array< SViewSet > SViewSet::FromName ( string name )

static

Search all the SViewSet with the given name.

Parameters

name	(string) The name to find

Returns

(Array<SViewSet>) All the SViewSet with the given name

FromSel()

static Array< SViewSet > SViewSet::FromSel ( )

static

Get all the selected SViewSet.

Returns

(Array<SViewSet>) All the selected SViewSet

New() [1/2]

static SViewSet SViewSet::New ( boolean saveObjectsVisibility = true )

static

Default constructor to create an SViewSet.

Parameters

saveObjectsVisibility

(boolean) If true, save the objects visibility and representation mode

Returns

(SViewSet) The new SViewSet.

New() [2/2]

static SViewSet SViewSet::New ( SViewSet other )

static

Construct an SViewSet by copying other.

Parameters

other

(SViewSet) The other SViewSet to copy

Returns

(SViewSet) The new SViewSet.

toString()

string SViewSet::toString

(

)

Get the type of the variable.

Returns

(string) The type name

Update()

SViewSet::Update

(

boolean

saveObjectsVisibility

)

Update the SViewSet with the current position of the camera.

Parameters

saveObjectsVisibility

(boolean) If true, save the objects visibility and representation mode