The SClipping class is an abstract class. More...

#include <SClipping.h>

Inheritance diagram for SClipping:

Public Slots
	ActivateInAllScenes ()
	Activate the clipping object in all scenes of its document. More...

	ActivateInScene (uint iSceneIndex)
	Activate the clipping object in a given scene. More...

static Array	All (Number VisCrit)
	To get all the SClipping in the document. More...

	Clip (SComp Comp)
	Clip a SComp. More...

	ClipAll ()
	Clip all SComp in the current document. More...

	ClipTable (Array< SComp > CompTable)
	Clip a table of SComp. More...

	DeactivateInAllScenes ()
	Deactivate the clipping object in all scenes of its document. More...

	DeactivateInScene (uint iSceneIndex)
	Deactivate the clipping object in a given scene. More...

static Array	FromClick ()
	Launches a click interaction to select a SClipping in the scene. More...

static Array	FromName (String Name)
	Search all the component with the given name. More...

static Array	FromSel ()
	To get all the selected SClipping. More...

static Array	GetAllActivated (Number VisCrit)
	To get all activated SClipping in the document in the current scene. More...

String	toString ()
	Get the type of the variable. More...

static String	toString ()
	Get the type of the variable. More...

	Unclip (SComp Comp)
	Unclip a SComp. More...

	UnclipAll ()
	Unclip all SComp in the current document. More...

	UnclipTable (Array< SComp > CompTable)
	Unclip a table of SComp. More...

Public Slots inherited from SComp
	AddToDoc ()
	To add the object to the document. More...

static Array	All (Number VisCrit)
	To get all the SComp in the document. More...

	ApplyTransformation (SMatrix iMatrix)
	To apply a geometric transformation to the current object by making a product with the given matrix. More...

	Clear ()
	To deallocate object memory. More...

static Array	FromClick ()
	Launches a click interaction to select a SComp in the scene. More...

static Array	FromName (String Name)
	Search all the component with the given name. More...

static Array	FromSel ()
	To get all the selected SComp. More...

Array	GetBoundingBox ()
	Calculates the bounding box of the component. More...

Array	GetColors ()
	To get the colors of the component. More...

String	GetFolderName ()
	The component containing folder's name. More...

String	GetName ()
	The component's name. More...

String	GetPath ()
	To get the full path of a comp in the tree. More...

	Invert ()
	Normal of the component is inverted. More...

Boolean	IsInDoc ()
	Return if the component is in the document or not. More...

Boolean	IsVisible ()

	MoveToGroup (String GroupPath, Boolean MoveInsideTopParent)
	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. More...

	RemoveFromDoc ()
	To remove the object from the document. More...

	SetClippable (Boolean clipping)
	Set clippable or not. More...

	SetColors (Number Red, Number Green, Number Blue)
	Sets the colors of the component. More...

	SetName (String ComponentName)
	To set the component's name. More...

	SetRepresentationType (RepresentationTypeEnum Representation)
	The shading type of the component is modified. More...

	SetTransparency (Number Alpha)
	Sets the transparency of the component. More...

	SetVisibility (Boolean Visible)
	Sets the component to be visible, or not visible. More...

String	toString ()
	Get the type of the variable. More...

String	toString ()
	Get the type of the variable. More...

	Translate (SVector Vector)
	To make a translation of the current object with an SVector. More...

Public Slots inherited from SObject
	Clear ()
	To deallocate memory of the object. More...

String	toString ()
	Get the type of the variable. More...

Additional Inherited Members
Public Types inherited from SComp
enum	RepresentationTypeEnum { SMOOTH , FLAT , WIRE , SMOOTH_WIRE , FLAT_WIRE , SMOOTH_ROTWIRE , FLAT_ROTWIRE , TEXTURE , INSPECTION }
	The different representation types for inherited classes. Use (inherited class).SMOOTH. Example: for a cloud, use SCloud.SMOOTH. More...

Detailed Description

The SClipping class is an abstract class.

Member Function Documentation

◆ ActivateInAllScenes

SClipping::ActivateInAllScenes ( )

inlineslot

Activate the clipping object in all scenes of its document.

◆ ActivateInScene

SClipping::ActivateInScene ( uint iSceneIndex )

slot

Activate the clipping object in a given scene.

◆ All

static Array SClipping::All ( Number VisCrit )

inlinestaticslot

To get all the SClipping in the document.

Return values

Array all the SClipping contained in the document

Parameters

[in]

VisCrit

Visible selection criteria

0 Keep if not visible
1 Keep if visible
2 (Default) Indifferent

◆ Clip

SClipping::Clip ( SComp Comp )

inlineslot

Clip a SComp.

◆ ClipAll

SClipping::ClipAll ( )

inlineslot

Clip all SComp in the current document.

◆ ClipTable

SClipping::ClipTable ( Array< SComp > CompTable )

inlineslot

Clip a table of SComp.

◆ DeactivateInAllScenes

SClipping::DeactivateInAllScenes ( )

inlineslot

Deactivate the clipping object in all scenes of its document.

◆ DeactivateInScene

SClipping::DeactivateInScene ( uint iSceneIndex )

slot

Deactivate the clipping object in a given scene.

◆ FromClick

static Array SClipping::FromClick ( )

inlinestaticslot

Launches a click interaction to select a SClipping in the scene.

Warning: This function will break the script, and wait for user interaction

Return values

Array.ErrorCode	The error code 0: Success, the SClipping is selected. 1: Nothing is selected. 2: The ESCape key has been pressed
Array.Clipping	the Clipping selected

◆ FromName

static Array SClipping::FromName ( String Name )

inlinestaticslot

Search all the component with the given name.

Return values

Array all the SClipping object with the given name

◆ FromSel

static Array SClipping::FromSel ( )

staticslot

To get all the selected SClipping.

Return values

Array all the SClipping selected

◆ GetAllActivated

static Array SClipping::GetAllActivated ( Number VisCrit )

staticslot

To get all activated SClipping in the document in the current scene.

Return values

Array all the SClipping contained in the document

Parameters

[in]

VisCrit

Visible selection criteria

0 Keep if not visible
1 Keep if visible
2 (Default) Indifferent

◆ toString [1/2]

String SClipping::toString ( )

slot

Get the type of the variable.

◆ toString [2/2]

static String SClipping::toString ( )

staticslot

Get the type of the variable.

◆ Unclip

SClipping::Unclip ( SComp Comp )

inlineslot

Unclip a SComp.

◆ UnclipAll

SClipping::UnclipAll ( )

inlineslot

Unclip all SComp in the current document.

◆ UnclipTable

SClipping::UnclipTable ( Array< SComp > CompTable )

inlineslot

Unclip a table of SComp.

Public Slots

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ ActivateInAllScenes

◆ ActivateInScene

◆ All

◆ Clip

◆ ClipAll

◆ ClipTable

◆ DeactivateInAllScenes

◆ DeactivateInScene

◆ FromClick

◆ FromName

◆ FromSel

◆ GetAllActivated

◆ toString [1/2]

◆ toString [2/2]

◆ Unclip

◆ UnclipAll

◆ UnclipTable