"Fossies" - the Fresh Open Source Software Archive

Member "doc_html/Three/classCGAL_1_1Three_1_1Scene__interface.html" (8 Nov 2019, 47700 Bytes) of package /linux/misc/CGAL-5.0-doc_html.tar.xz:

Caution: In this restricted "Fossies" environment the current HTML page may not be correctly presentated and may have some non-functional links. You can here alternatively try to browse the pure source code or just view or download the uninterpreted raw source code. If the rendering is insufficient you may try to find and view the page on the project site itself.

\( \newcommand{\E}{\mathrm{E}} \) \( \newcommand{\A}{\mathrm{A}} \) \( \newcommand{\R}{\mathrm{R}} \) \( \newcommand{\N}{\mathrm{N}} \) \( \newcommand{\Q}{\mathrm{Q}} \) \( \newcommand{\Z}{\mathrm{Z}} \) \( \def\ccSum #1#2#3{ \sum_{#1}^{#2}{#3} } \def\ccProd #1#2#3{ \sum_{#1}^{#2}{#3} }\)

CGAL 5.0 - Three
List of all members | Public Types | Public Member Functions
CGAL::Three::Scene_interface Class Referenceabstract

#include <CGAL/Three/Scene_interface.h>

Inherited by Scene.

Definition

This is the class given to the plugins to interact with the scene.

Examples:
Three/Example_plugin/Basic_item_plugin.cpp, Three/Example_plugin/Basic_plugin.cpp, Three/Example_plugin/Dock_widget_plugin.cpp, and Three/Example_plugin/Example_plugin.cpp.

Public Types

typedef CGAL::Bbox_3 Bbox
 A bounding box is a box with each face corresponding to an extremum of its contents.
 
typedef int Item_id
 Integer used as the index of a Scene_item. More...
 

Public Member Functions

virtual Item_id addItem (CGAL::Three::Scene_item *item)=0
 Adds an item to the Geometric Objects list. More...
 
virtual void addChild (Scene_item *item)=0
 Adds a CGAL::Three::Scene_item* to the list of children.
 
virtual Scene_item * replaceItem (Item_id id, CGAL::Three::Scene_item *item, bool emit_item_about_to_be_destroyed=false)=0
 Replaces an item by a new one in the scene. More...
 
virtual void changeGroup (CGAL::Three::Scene_item *item, CGAL::Three::Scene_group_item *target_group)=0
 Moves item to the targeted group.
 
virtual Item_id erase (Item_id)=0
 Erases an item in the list. More...
 
virtual int erase (QList< int >)=0
 Deletes the items with the target indices. More...
 
virtual Item_id duplicate (Item_id id)=0
 Creates a copy of the item whith the id id. More...
 
virtual int numberOfEntries () const =0
 The number of items. More...
 
virtual CGAL::Three::Scene_item * item (Item_id id) const =0
 The idth item. More...
 
virtual Item_id item_id (CGAL::Three::Scene_item *item) const =0
 The id of item More...
 
virtual Item_id mainSelectionIndex () const =0
 The currently selected item's index. More...
 
virtual QList< Item_id > selectionIndices () const =0
 The id of the currently selected item. More...
 
virtual Item_id selectionAindex () const =0
 Item_A is designated with the column A/B in the Geometric Objetcts widget. More...
 
virtual Item_id selectionBindex () const =0
 Item_B is designated with the column A/B in the Geometric Objetcts widget. More...
 
virtual Bbox bbox () const =0
 The scene's Bbox. More...
 
virtual double len_diagonal () const =0
 The length of the diagonal of the scene's Bbox. More...
 
virtual void itemChanged (Item_id i)=0
 Updates the information about the ith item in the Geometric Objects list and redraws the scene. More...
 
virtual void itemChanged (CGAL::Three::Scene_item *item)=0
 Updates the information about item in the Geometric Objects list and redraws the scene. More...
 
virtual void itemVisibilityChanged (CGAL::Three::Scene_item *)=0
 Re computes the scene Bbox without recentering it.
 
virtual void setSelectedItem (Item_id)=0
 Clears the current selection then sets the selected item to the target index. More...
 
virtual void setUpdatesEnabled (bool b)=0
 ignore data updating. More...
 
virtual void allItemsChanged ()=0
 Updates all the items in the SceneView.
 

Member Typedef Documentation

◆ Item_id

typedef int CGAL::Three::Scene_interface::Item_id

Integer used as the index of a Scene_item.

An item's index is its position in the Geometric Objects list.

Member Function Documentation

◆ addItem()

virtual Item_id CGAL::Three::Scene_interface::addItem ( CGAL::Three::Scene_item *  item)
pure virtual

Adds an item to the Geometric Objects list.

Returns
the index of the new item.

◆ bbox()

virtual Bbox CGAL::Three::Scene_interface::bbox ( ) const
pure virtual

The scene's Bbox.

Returns
the scene's bounding box
See also
Scene_interface::Bbox

◆ duplicate()

virtual Item_id CGAL::Three::Scene_interface::duplicate ( Item_id  id)
pure virtual

Creates a copy of the item whith the id id.

Returns
the index of the new item (-1 on error).

◆ erase() [1/2]

virtual Item_id CGAL::Three::Scene_interface::erase ( Item_id  )
pure virtual

Erases an item in the list.

Returns
the index of the item just before the one that is erased, or just after.
-1 if the list is empty.

◆ erase() [2/2]

virtual int CGAL::Three::Scene_interface::erase ( QList< int >  )
pure virtual

Deletes the items with the target indices.

Returns
the index of the polyhedron just before the one that is erased, or just after. Returns -1 if the list is empty.

◆ item()

virtual CGAL::Three::Scene_item* CGAL::Three::Scene_interface::item ( Item_id  id) const
pure virtual

The idth item.

Returns
the item with the specified index.

◆ item_id()

virtual Item_id CGAL::Three::Scene_interface::item_id ( CGAL::Three::Scene_item *  item) const
pure virtual

The id of item

Returns
the id of the specified item.

◆ itemChanged() [1/2]

virtual void CGAL::Three::Scene_interface::itemChanged ( Item_id  i)
pure virtual

Updates the information about the ith item in the Geometric Objects list and redraws the scene.

◆ itemChanged() [2/2]

virtual void CGAL::Three::Scene_interface::itemChanged ( CGAL::Three::Scene_item *  item)
pure virtual

Updates the information about item in the Geometric Objects list and redraws the scene.

◆ len_diagonal()

virtual double CGAL::Three::Scene_interface::len_diagonal ( ) const
pure virtual

The length of the diagonal of the scene's Bbox.

Returns
the length of the bounding box's diagonal.

◆ mainSelectionIndex()

virtual Item_id CGAL::Three::Scene_interface::mainSelectionIndex ( ) const
pure virtual

The currently selected item's index.

Returns
the currently selected item's index.
-1 if none or several items are selected

◆ numberOfEntries()

virtual int CGAL::Three::Scene_interface::numberOfEntries ( ) const
pure virtual

The number of items.

Returns
the number of items in the scene.

◆ replaceItem()

virtual Scene_item* CGAL::Three::Scene_interface::replaceItem ( Item_id  id,
CGAL::Three::Scene_item *  item,
bool  emit_item_about_to_be_destroyed = false 
)
pure virtual

Replaces an item by a new one in the scene.

The item which id is id is replaced by item. The first one is deleted and gives its index to the second one. If emit_item_about_to_be_destroyed is true, emits an itemAboutToBeDestroyed signal.

Returns
a pointer to the old item.

◆ selectionAindex()

virtual Item_id CGAL::Three::Scene_interface::selectionAindex ( ) const
pure virtual

Item_A is designated with the column A/B in the Geometric Objetcts widget.

Returns
the index of the Item_A

◆ selectionBindex()

virtual Item_id CGAL::Three::Scene_interface::selectionBindex ( ) const
pure virtual

Item_B is designated with the column A/B in the Geometric Objetcts widget.

Returns
the index of the Item_B

◆ selectionIndices()

virtual QList<Item_id> CGAL::Three::Scene_interface::selectionIndices ( ) const
pure virtual

The id of the currently selected item.

Returns
the list of currently selected items indices.

◆ setSelectedItem()

virtual void CGAL::Three::Scene_interface::setSelectedItem ( Item_id  )
pure virtual

Clears the current selection then sets the selected item to the target index.

Used to update the selection in the Geometric Objects view.

◆ setUpdatesEnabled()

virtual void CGAL::Three::Scene_interface::setUpdatesEnabled ( bool  b)
pure virtual

ignore data updating.

This will ignore all the individual calls to itemChanged() until setUpdatesEnabled() is called whith b being true.