SClipping Class Reference

Abstract class used by the following derived classes: SClippingBox and SClippingPlane. More...

Inheritance diagram for SClipping:

Public Member Functions
	ActivateInAllScenes ()
	Activate the clipping object in all scenes.
	ActivateInScene (number sceneIndex)
	Activate the clipping object in the given scene.
	Clip (SComp comp)
	Clip an SComp.
	ClipAll ()
	Clip all SComp in the current document.
	ClipTable (Array< SComp > compTable)
	Clip a table of SComp.
	DeactivateInAllScenes ()
	Deactivate the clipping object in all scenes.
	DeactivateInScene (number sceneIndex)
	Deactivate the clipping object in a given scene.
boolean	IsActivatedInAllScenes ()
	Return if the SClipping is activated in all scenes.
boolean	IsActivatedInScene (number sceneIndex)
	Return if the SClipping is activated in a given scene.
boolean	IsClipped (SComp comp)
	Return if the SComp is clipped or not.
string	toString ()
	Get the type of the variable.
	Unclip (SComp comp)
	Unclip an SComp.
	UnclipAll ()
	Unclip all SComp in the current document.
	UnclipTable (Array< SComp > compTable)
	Unclip a table of SComp.
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< SClipping >	All (VisibilityEnum visCrit=SComp.ANY_VISIBILITY)
	Get all the SClipping in the document.
static Object	FromClick ()
	Launch an interaction to select a SClipping in the scene.
static Array< SClipping >	FromName (string name)
	Search all the SClipping with the given name.
static Array< SClipping >	FromSel ()
	Get all the selected SClipping.
static Array< SClipping >	GetAllActivated (VisibilityEnum visCrit=SComp.ANY_VISIBILITY)
	Get all the activated SClipping in the document.
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

Abstract class used by the following derived classes: SClippingBox and SClippingPlane.

Member Function Documentation

ActivateInScene()

SClipping::ActivateInScene

(

number

sceneIndex

)

Activate the clipping object in the given scene.

Parameters

sceneIndex

(number) The index of the scene

All()

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

static

Get all the SClipping 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<SClipping>) Array of all the SClipping contained in the document, that fulfill the visibility criteria

Clip()

SClipping::Clip

(

SComp

comp

)

Clip an SComp.

Parameters

comp	(SComp) The SComp to clip

ClipTable()

SClipping::ClipTable

(

Array< SComp >

compTable

)

Clip a table of SComp.

Parameters

compTable

(Array<SComp>) The table of SComp to clip

DeactivateInScene()

SClipping::DeactivateInScene

(

number

sceneIndex

)

Deactivate the clipping object in a given scene.

Parameters

sceneIndex

(number) The index of the scene

FromClick()

static Object SClipping::FromClick ( )

static

Launch an interaction to select a SClipping in the scene.

Warning

This function will pause the script, and wait for user interaction

Return values

ret.ErrorCode	(number) The error code 0: No error, the SClipping is selected. 1: Nothing is selected. 2: The ESCape key has been pressed
ret.Clipping	(SClipping) The selected SClipping

FromName()

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

static

Search all the SClipping with the given name.

Parameters

name	(string) The name to find

Returns

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

FromSel()

static Array< SClipping > SClipping::FromSel ( )

static

Get all the selected SClipping.

Returns

(Array<SClipping>) All the selected SClipping

GetAllActivated()

static Array< SClipping > SClipping::GetAllActivated ( VisibilityEnum visCrit = SComp.ANY_VISIBILITY )

static

Get all the activated SClipping 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<SClipping>) All the activated SClipping in the document

IsActivatedInAllScenes()

boolean SClipping::IsActivatedInAllScenes

(

)

Return if the SClipping is activated in all scenes.

Return values

true	The SClipping is activated in all scenes
false	The SClipping is not activated in all scenes

IsActivatedInScene()

boolean SClipping::IsActivatedInScene

(

number

sceneIndex

)

Return if the SClipping is activated in a given scene.

Parameters

sceneIndex

(number) The index of the scene

Return values

true	The SClipping is activated in a given scene
false	The SClipping is deactivated in a given scene

IsClipped()

boolean SClipping::IsClipped

(

SComp

comp

)

Return if the SComp is clipped or not.

Parameters

comp	(SComp) The SComp

Return values

true	The SComp is clipped by the SClipping
false	The SComp is not clipped by the SClipping

toString()

string SClipping::toString

(

)

Get the type of the variable.

Returns

(string) The type name

Unclip()

SClipping::Unclip

(

SComp

comp

)

Unclip an SComp.

Parameters

comp	(SComp) The SComp to unclip

UnclipTable()

SClipping::UnclipTable

(

Array< SComp >

compTable

)

Unclip a table of SComp.

Parameters

compTable

(Array<SComp>) The table of SComp to unclip