Cyclone 3DR Script
from Technodigit, part of Hexagon. Copyright 1997-2021.
SViewSet Class Reference

ViewSet manipulation class.
The SViewSet class will save position of the camera and visibility of the SComp.
The SViewSet creation can be done by calling the static functions:
. More...

Inheritance diagram for SViewSet:
SComp SObject

Public Slots

static Array All (Number VisCrit)
 To get all the SComp in the document. 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...
 
static SViewSet New (Boolean SaveComponentsVisibility)
 Default constructor to create a SViewSet with current position. More...
 
static SViewSet New (SViewSet Other)
 Constructs an SViewSet by copying Other. More...
 
String toString ()
 Get the type of the variable. More...
 
static String toString ()
 Get the type of the variable. More...
 
 Update (Boolean SaveComponentsVisibility)
 Update the SViewSet with the current position of the camera. 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 Matrix)
 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 ()
 Displays a dialog box to select an 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 ()
 
String GetName ()
 
 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

ViewSet manipulation class.
The SViewSet class will save position of the camera and visibility of the SComp.
The SViewSet creation can be done by calling the static functions:
.

  • New() to create an empty SViewSet.
  • New() to copy an existing SViewSet.
    You must call Update() to initialize or save the current position
    You must call SetVisibility(true) to restore the position of the camera

Member Function Documentation

◆ All

static Array SViewSet::All ( Number  VisCrit)
inlinestaticslot

To get all the SComp in the document.

Return values
Arrayall the SViewSet contained in the document
Parameters
[in]VisCritVisible selection criteria
  • 0 Keep if not visible
  • 1 Keep if visible
  • 2 (Default) Indifferent

◆ FromName

static Array SViewSet::FromName ( String  Name)
inlinestaticslot

Search all the component with the given name.

Return values
Arrayall the SViewSet with the given name

◆ FromSel

static Array SViewSet::FromSel ( )
staticslot

To get all the selected SComp.

Return values
Arrayall the SViewSet selected

◆ New [1/2]

static SViewSet SViewSet::New ( Boolean  SaveComponentsVisibility)
staticslot

Default constructor to create a SViewSet with current position.

Parameters
[in]SaveComponentsVisibilityif true, save the components visibility

◆ New [2/2]

static SViewSet SViewSet::New ( SViewSet  Other)
staticslot

Constructs an SViewSet by copying Other.

◆ toString [1/2]

String SViewSet::toString ( )
slot

Get the type of the variable.

◆ toString [2/2]

static String SViewSet::toString ( )
staticslot

Get the type of the variable.

◆ Update

SViewSet::Update ( Boolean  SaveComponentsVisibility)
slot

Update the SViewSet with the current position of the camera.

Parameters
[in]SaveComponentsVisibilityif true, save the components visibility