Base class for all popup windows. More...

#include <PopupWindows.h>

Public Member Functions
virtual BaseClass *	GetClass ()
	Class to be edit in pop-up window. More...

virtual void	CreateUI (FrameWidget *root, const Rct &R)
	If returned class is NULL the next function will be called to create UI. More...

virtual int	PresentInWindowsList ()
	Is it present in Windows->Popups? More...

virtual double	GetWindowSortValue ()
	The bigger value returned, the lower position in windows list the window will get. More...

virtual const char *	GetDefaultHotkey ()
	Get default hotkeys by default. More...

virtual bool	GetSizeWhenTriggeredByHotkey (cVec2 &size)
	Resturn true and set special size when the window triggered by hokey. More...

virtual int	PresentInNaviBar ()
	Is it present in Top Navigation Bar? More...

virtual float	PresentInActivityBar ()
	Is it present in Activity (top right list of active elements like current pen, material, stencil) panel? More...

virtual IconInfo	GetIconInActivityBar ()
	returns the icon for the activity bar. More...

virtual IconInfo	GetIcon ()
	Icon name to show in navi bar. More...

virtual const char *	GetWindowID ()
	Window name to show in Windows->Popups and window header. More...

virtual int	GetFixedWidth ()
	Returns nonzero value if you need fixed window width when called from Navi bar. More...

virtual int	GetFixedHeight ()
	Returns nonzero value if you need fixed window height when called from Navi bar. More...

virtual cVec2	GetDefaultPlacement ()
	Get default placement and size. More...

virtual float	GetDefaultWidth ()
	Returns default window width. More...

virtual float	GetDefaultHeight ()
	Returns default window width. More...

virtual bool	KeepExpanded ()
	Return true if you want to expand class parameters on the full height (whenever possible) when class hashsumm changes. More...

virtual void	OnActivate ()
	Called when Show or PopUp or Window->Popups->... called. More...

virtual void	OnClose ()
	Called when user closes the window or Close() called. More...

virtual void	Process ()
	Called each frame. More...

void	Show ()
	Show the window if it is hidden. More...

void	AutoShow ()
	Show the window if it is called from menu, pop-up window temporary if it is called by hotkey. More...

void	PopUp ()
	Pop-up under cursor for temporary showing. More...

void	Close ()
	Close the window. More...

void	PopUpNearRect (const Rct &R, int Xalign, int Yalign)
	Pop-up near rectangle. X/Y alingn: 0:Left, 1:Center, 2:Right. More...

void	RefreshUI ()
	Refresh. More...

bool	IsInDock ()
	check if window is in dock More...

virtual DWORD	GetSaveMagic ()
	serialize the window data to the 3B file More...

virtual void	OnNewScene ()
	called when New scene triggered More...

BaseClass *	GetRoot ()
	BaseClass is like a tree, and you always can get the root of the tree using this function. More...

virtual DWORD	GetClassMask ()
	Masking elements of class. Each member has mask. Element is serializable/visible only if (it's_mask & hosting_class_mask) != 0. More...

virtual void	reset_class (void *DataPtr=nullptr)
	Clearing all registered content of the class. If DataPtr is nullptr, this class will be cleared. More...

virtual void	CountObjects (int &required_index, int counter, HashSummator hash, BaseClassElement result, const std::function< bool(BaseClassElement )> *ForEachElem=nullptr, bool OnlyPointersMode=false)
	This is the main function used for the access to class members. Each class that has SERIALIZE section creates this function automatically. It may count members, return hash, give element-wise access to any member. Instead of keeping registered fields that routine gives fast dynamic access to any member. If you making own container, you should create this function as well, othervice your class will not be serialized correctly even if you will make GetElement(...) function. More...

void	ForEach (const std::function< bool(BaseClassElement *el)> &fn, bool OnlyPointsers=false)
	Calls function for each class member. This function used in _EACH ... _EACH_END cycle. More...

virtual bool	CopyBaseClass (BaseClass *Dest, bool Add=false)
	Copy base class to other class uning names correspondence. More...

virtual void	Save (TagsList &xml, void ClassPtr, void Extra=NULL)
	Save class to the XML structure. More...

virtual bool	Load (TagsList &xml, void ClassPtr, void Extra=NULL)
	Load the class from the XML structure. More...

virtual bool	FullCopy (const void SrcData, const void SrcDataExtra, BaseClass Dest, void DestData, void DstDataExtra, CECopyContext C)
	Fast copy from one BaseClass to another. Names and types correspondence used to copy. More...

virtual void	SaveBin (void Data, void Extra, BinStream Out, Enumerator ExDictionary, Enumerator *SkipList)
	Save in binaly form. Use only for temporary storage in memory!!! More...

virtual void	LoadBin (void Data, void Extra, BinStream In, Enumerator ExDictionary)
	Load the class from the memory. Use only for temporary storage in memory!!! More...

virtual void	UpdateHash (HashSummator &S, void data=nullptr, void extra=nullptr)
	returns hash value dependent on data fields of this class More...

virtual int	GetAmountOfElementsInUI ()
	return amount of elements represented in UI More...

virtual int	GetAmountOfElementsInXML ()
	return amount of elements taht will be stored in XML More...

virtual const char *	GetClassName () const
	return class name there if need. Usually you don't need, if you are using AUTONEW or SERIALIZE More...

virtual void	RegisterMembers ()
	Reload this function to register members. Usually you don't need to do this if you are using any of SERIALIZE methods of registration. More...

virtual int	GetAmountOfElements ()
	return complete amount of elements. Even invisible, masked and non-serialized elements will be counted More...

virtual bool	CheckDirectCasting () const
	BaseClass corresponds to some other data type. For example _int correctonds to int, etc... In this case you can't cast pointer to data to BaseClass*. But in some cases BaseClass may be directlt castable, for example if it has registered members, or it is ClassArray. This function is to define if class is directly castable. More...

virtual int	GetClassSize () const
	return actual size of this class More...

virtual BaseClass *	new_element () const
	construct pointer to class of the same type like this. Elements will not be copied into the new place More...

virtual bool	GetElement (BaseClassElement &res, int idx, const void Ptr=nullptr, const void Extra=nullptr)

bool	GetElementByName (const char Name, void Ptr, void *Extra, BaseClassElement &res, bool UI=false, bool Serialize=true)
	The function returns complete information about the member by it's name. More...

void	DeleteDefaultSubFields (TagsList &xml, void ClassPtr, void Extra=NULL)
	Short form saving. Fields that are unchanged in comparison to default will be skipped in XML. More...

virtual bool	ShouldSaveInShortForm ()
	Return true if class should be saved in short form mandatory. More...

virtual int	ExpandWith (const char ElmName, void base)
	Expand array with class ElmName. More...

virtual bool	DelElement (int Index)
	removes element if the operation supported More...

template<class Type = BaseClass>
bool	valid () const
	call it to check if this BaseClass pointer is valid More...

BaseClass *	auto_cast (void *ptr) const
	if class is directly castable the function returns ptr cased to BaseClass, othervice this pointrer returned. If NULL returned - something is wrong. More...

virtual bool	ReadFromFile (const char *Name)
	Save the object to file or binary stream. Example. More...

virtual void	FromStr (const comms::cStr &bs)

virtual bool	CheckIfFunction () const
	Special function for integrating in editor. More...

virtual int	condition_call (void *ptr)
	return -1 to do nothing, 0 if you want to hide everything after this registered member, 1 if you want to show More...

virtual void	SetParent (BaseClass *Parent)
	set parent recursively More...

virtual void	SimplySetParent (BaseClass *Parent)
	set parent directly to this, not affecting members More...

virtual bool	CheckCompartabilityWith (const char *TypeName, int TypeSize)
	Checking for errors of registration. More...

virtual bool	ProcessInEditor (BaseClass *Parent)
	Editor will call next function always when it is visible in tree. Return true if overriden. More...

virtual bool	HandleKey (int code)
	Editor will call next function when key pressed. More...

virtual bool	OnChangeMember (BaseClass MembClass, void MembPtr, void MembExtra, const char MembName)
	Editor will call it every time when member changes and editor is able to recognise it. More...

virtual void	BeforeChangeMember (BaseClass MembClass, void MembPtr, void MembExtra, const char MembName)
	Editor will call it every time before the changes. More...

virtual BaseWidget *	OnCreateControlFromScratch (const ClassEditorContext &Context, Rct &Rect)
	Create completely own control for ClassEditor. More...

virtual void	OnModifyControl (const char FieldName, BaseWidget W, ClassEditorContext &Context)
	Call for every member of registered class registered class. More...

virtual bool	CanBeDragged (const char *MemberID, int &dx, int &dy)
	Use it for build a Drag & Drop element. More...

virtual bool	CanAcceptDrag (const char *MemberID)

virtual bool	OnStartDrag (const char *MemberID)

virtual bool	OnEndDrag (const char *MemberID)

virtual bool	OnAcceptDrag (BaseClass DraggedItemParent, const char DraggedMemberID, const char *AcceptorMemberID, iRct MyRect)

void	SetParents ()
	set parents to this for all child members More...

void	SetParentsSafe ()
	set parents to this for all child members, each child will be tested for validity More...

Static Public Member Functions
static void	Register (PopupWindow *win)
	Registering window in system. More...

Static Public Attributes
static const char *	CurrentSaveFile
	If user triggers saving class to file, last filename stored there. More...

Protected Attributes
BaseClass *	ParentBC
	pointer to the parent class in the tree More...

DWORD	_ClassMask
	Result of GetClassMask() written there. GetClassMask() is not const, so can't use it in const functions. The field introduced to use masking in const functions. More...

Static Protected Attributes
static std::mutex *	pmutex
	mutex for register_this / remove_this More...

static uni_hash< _empty, cPtrDiff,(1<< 18), 2048 > *	presence
	each BaseClass registered in this list More...

Detailed Description

Base class for all popup windows.

Window can be placed in the control panel.

Inheritance diagram for PopupWindow:

Member Function Documentation

BaseClass* BaseClass::auto_cast ( void * ptr ) const

inherited

if class is directly castable the function returns ptr cased to BaseClass, othervice this pointrer returned. If NULL returned - something is wrong.

void PopupWindow::AutoShow ( )

Show the window if it is called from menu, pop-up window temporary if it is called by hotkey.

References GetSizeWhenTriggeredByHotkey().

virtual void BaseClass::BeforeChangeMember	(	BaseClass *	MembClass,
		void *	MembPtr,
		void *	MembExtra,
		const char *	MembName
	)

inlinevirtualinherited

Editor will call it every time before the changes.

See Also: OnChangeMember()

Reimplemented in CurvePrimitive.

virtual bool BaseClass::CanAcceptDrag ( const char * MemberID )

inlinevirtualinherited

See Also: CanBeDragged(), OnStartDrag(), OnEndDrag(), OnAcceptDrag()

Reimplemented in ItemsTree.

Referenced by CreateControlWithBaseClass().

virtual bool BaseClass::CanBeDragged	(	const char *	MemberID,
		int &	dx,
		int &	dy
	)

inlinevirtualinherited

Use it for build a Drag & Drop element.

See Also: CanAcceptDrag(), OnStartDrag(), OnEndDrag(), OnAcceptDrag()

Reimplemented in ItemsTree.

Referenced by CreateControlWithBaseClass().

virtual bool BaseClass::CheckCompartabilityWith	(	const char *	TypeName,
		int	TypeSize
	)

inlinevirtualinherited

Checking for errors of registration.

virtual bool BaseClass::CheckDirectCasting ( ) const

inlinevirtualinherited

BaseClass corresponds to some other data type. For example _int correctonds to int, etc... In this case you can't cast pointer to data to BaseClass*. But in some cases BaseClass may be directlt castable, for example if it has registered members, or it is ClassArray. This function is to define if class is directly castable.

Returns: Return true if void* ClassPtr may be directly casted to BaseClass*

Reimplemented in ClassRef< X >, ClassRef< BaseClass >, ClassPtr< X >, ClassPtr< BaseClass >, ClassPtr< VoxMethadata >, ClassPtr< BasicDistortion >, ClassPtr< OnePenStyle >, ClassPtr< CurvePrimitive >, ClassPtr< ModelPreview >, ClassPtr< BasePrim >, ClassArray< X >, ClassArray< TextItem >, ClassArray< BaseKnot >, ClassArray< IconicText >, ClassArray< BaseClass >, ClassArray< mitem >, ClassArray< PopupWindow >, ClassArray< OneQAItem >, ClassArray< LayerMaterial >, ClassArray< SplinePoint3D >, ClassArray< BaseNode >, ClassArray< ModelItem >, ClassArray< bcVec3 >, ClassArray< FacesCluster >, ClassArray< OneToolPreset >, ClassArray< OneVolumeTransform >, ClassArray< ItemsTree >, ClassArray< VolumeObject >, ClassArray< BasicDistortion >, ClassArray< Pt3D2 >, ClassArray< CurvElement2 >, ClassArray< ABOcTreeLevel >, ClassArray< FolderState >, ClassArray< my_test1 >, ClassArray< BaseWidget >, ClassArray< ExShaderParam >, ClassArray< GuideSection >, ClassArray< ShaderPreviewStrct >, ClassArray< BaseDrawingPrim >, ClassArray< OneFold >, ClassArray< RTUVSet >, ClassArray< ClassRef< BaseClass > >, ClassArray< StringsList >, ClassArray< MeasureElement >, ClassArray< OneRandomPen >, ClassArray< OnePreset >, ClassArray< ScrollParam >, ClassArray< CurveReference >, ClassArray< OneLayerInfo >, ClassArray< OneSubObject >, ClassArray< OneMaterial >, ClassArray< ImpUVSet2 >, ClassArray< RecoSample >, ClassArray< NaviEvent >, ClassArray< ExampleOfLoadSaveDataTo3BFileExtension::MyClassTest >, ClassArray< FolderRoot >, ClassArray< WindowPos >, ClassArray< RetopoGroup >, ClassArray< BaseEffectFlow >, ClassArray< FileEnabler >, ClassArray< One2DCurve >, ClassArray< VarStorage >, ClassArray< DbgLItem >, ClassArray< wCurvePoint >, ClassArray< OneMorphInfo >, ClassArray< psd_Layer >, ClassArray< SubFaceList >, ClassArray< MRenderTarget >, ClassArray< RenamePair >, ClassArray< SplinePoint3 >, ClassArray< DockLayoutElement >, ClassArray< Point3D >, ClassArray< CellsStorage >, ClassArray< CoreScriptTempItem >, ClassArray< JointPreview >, ClassArray< SplinePoint2 >, ClassArray< SplineCurve >, ClassArray< SubdWeights >, ClassArray< OneExportTexture >, ClassArray< DragNDropToolItem >, ClassArray< TempPt >, ClassArray< OneMtlInUVSet >, ClassArray< OneHotKey >, ClassArray< ExtraLight >, ClassArray< SphereOfInfluence >, ClassArray< ImpUV2 >, ClassArray< OneMtlLayer >, ClassArray< SplinePoint >, ClassArray< SliderState >, ClassArray< CustomLeftPanel >, ClassArray< cElement >, ClassArray< LwoNode >, ClassArray< ImpUVSet >, ClassArray< RetopoUVSet >, ClassArray< OneDrawnStroke >, ClassArray< LayerData >, ClassArray< CurvePrimitive >, ClassArray< KeptPolygon >, ClassArray< NodesCategory >, ClassArray< SymmetryState >, ClassArray< CurvedChunk >, ClassArray< BasePrim >, ClassArray< CameraShortcut >, ClassArray< VMapType >, VoxelExtension, StringsList, and KnotReference.

Referenced by CreateControlWithBaseClass().

virtual bool BaseClass::CheckIfFunction ( ) const

inlinevirtualinherited

Special function for integrating in editor.

Referenced by CreateControlWithBaseClass().

void PopupWindow::Close ( )

Close the window.

virtual int BaseClass::condition_call ( void * ptr )

inlinevirtualinherited

return -1 to do nothing, 0 if you want to hide everything after this registered member, 1 if you want to show

virtual bool BaseClass::CopyBaseClass	(	BaseClass *	Dest,
		bool	Add = `false`
	)

virtualinherited

Copy base class to other class uning names correspondence.

Parameters

Dest	The destination object
Add	Add members to class arrays or replace

Returns: true if successful

Referenced by CSurfaceSwept::RequiresUpdate(), CSurfaceRotate::RequiresUpdate(), CSurfacePrism::RequiresUpdate(), CSurfaceSwept2::RequiresUpdate(), CSurfaceSwept3::RequiresUpdate(), CSurfaceNGenerTwoGuide::RequiresUpdate(), CSurfaceRotate::Update(), CSurfacePrism::Update(), CSurfaceSwept2::Update(), CSurfaceSwept3::Update(), and CSurfaceNGenerTwoGuide::Update().

virtual void BaseClass::CountObjects	(	int &	required_index,
		int *	counter,
		HashSummator *	hash,
		BaseClassElement *	result,
		const std::function< bool(BaseClassElement )>	ForEachElem = `nullptr`,
		bool	OnlyPointersMode = `false`
	)

inlinevirtualinherited

This is the main function used for the access to class members. Each class that has SERIALIZE section creates this function automatically.
It may count members, return hash, give element-wise access to any member. Instead of keeping registered fields that routine gives fast dynamic access to any member.
If you making own container, you should create this function as well, othervice your class will not be serialized correctly even if you will make GetElement(...) function.

Parameters

required_index	Index of required element if result != nullptr
counter	if nonzero, the elements count returned there.
hash	if nonzero, returns hash value for this class.
result	if nonzero, gives access to the member with index required_index.
ForEachElem	if nonzero, the function will be called for each class element.
OnlyPointersMode	If true, the field name will not be filled for speed purposes.

Reimplemented in ClassRef< X >, ClassRef< BaseClass >, ClassPtr< X >, ClassPtr< BaseClass >, ClassPtr< VoxMethadata >, ClassPtr< BasicDistortion >, ClassPtr< OnePenStyle >, ClassPtr< CurvePrimitive >, ClassPtr< ModelPreview >, ClassPtr< BasePrim >, ClassArray< X >, ClassArray< TextItem >, ClassArray< BaseKnot >, ClassArray< IconicText >, ClassArray< BaseClass >, ClassArray< mitem >, ClassArray< PopupWindow >, ClassArray< OneQAItem >, ClassArray< LayerMaterial >, ClassArray< SplinePoint3D >, ClassArray< BaseNode >, ClassArray< ModelItem >, ClassArray< bcVec3 >, ClassArray< FacesCluster >, ClassArray< OneToolPreset >, ClassArray< OneVolumeTransform >, ClassArray< ItemsTree >, ClassArray< VolumeObject >, ClassArray< BasicDistortion >, ClassArray< Pt3D2 >, ClassArray< CurvElement2 >, ClassArray< ABOcTreeLevel >, ClassArray< FolderState >, ClassArray< my_test1 >, ClassArray< BaseWidget >, ClassArray< ExShaderParam >, ClassArray< GuideSection >, ClassArray< ShaderPreviewStrct >, ClassArray< BaseDrawingPrim >, ClassArray< OneFold >, ClassArray< RTUVSet >, ClassArray< ClassRef< BaseClass > >, ClassArray< StringsList >, ClassArray< MeasureElement >, ClassArray< OneRandomPen >, ClassArray< OnePreset >, ClassArray< ScrollParam >, ClassArray< CurveReference >, ClassArray< OneLayerInfo >, ClassArray< OneSubObject >, ClassArray< OneMaterial >, ClassArray< ImpUVSet2 >, ClassArray< RecoSample >, ClassArray< NaviEvent >, ClassArray< ExampleOfLoadSaveDataTo3BFileExtension::MyClassTest >, ClassArray< FolderRoot >, ClassArray< WindowPos >, ClassArray< RetopoGroup >, ClassArray< BaseEffectFlow >, ClassArray< FileEnabler >, ClassArray< One2DCurve >, ClassArray< VarStorage >, ClassArray< DbgLItem >, ClassArray< wCurvePoint >, ClassArray< OneMorphInfo >, ClassArray< psd_Layer >, ClassArray< SubFaceList >, ClassArray< MRenderTarget >, ClassArray< RenamePair >, ClassArray< SplinePoint3 >, ClassArray< DockLayoutElement >, ClassArray< Point3D >, ClassArray< CellsStorage >, ClassArray< CoreScriptTempItem >, ClassArray< JointPreview >, ClassArray< SplinePoint2 >, ClassArray< SplineCurve >, ClassArray< SubdWeights >, ClassArray< OneExportTexture >, ClassArray< DragNDropToolItem >, ClassArray< TempPt >, ClassArray< OneMtlInUVSet >, ClassArray< OneHotKey >, ClassArray< ExtraLight >, ClassArray< SphereOfInfluence >, ClassArray< ImpUV2 >, ClassArray< OneMtlLayer >, ClassArray< SplinePoint >, ClassArray< SliderState >, ClassArray< CustomLeftPanel >, ClassArray< cElement >, ClassArray< LwoNode >, ClassArray< ImpUVSet >, ClassArray< RetopoUVSet >, ClassArray< OneDrawnStroke >, ClassArray< LayerData >, ClassArray< CurvePrimitive >, ClassArray< KeptPolygon >, ClassArray< NodesCategory >, ClassArray< SymmetryState >, ClassArray< CurvedChunk >, ClassArray< BasePrim >, ClassArray< CameraShortcut >, ClassArray< VMapType >, StringsList, and KnotReference.

virtual void PopupWindow::CreateUI	(	FrameWidget *	root,
		const Rct &	R
	)

inlinevirtual

If returned class is NULL the next function will be called to create UI.

virtual bool BaseClass::DelElement ( int Index )

inlinevirtualinherited

removes element if the operation supported

Reimplemented in ClassRef< X >, ClassRef< BaseClass >, ClassPtr< X >, ClassPtr< BaseClass >, ClassPtr< VoxMethadata >, ClassPtr< BasicDistortion >, ClassPtr< OnePenStyle >, ClassPtr< CurvePrimitive >, ClassPtr< ModelPreview >, ClassPtr< BasePrim >, ClassArray< X >, ClassArray< TextItem >, ClassArray< BaseKnot >, ClassArray< IconicText >, ClassArray< BaseClass >, ClassArray< mitem >, ClassArray< PopupWindow >, ClassArray< OneQAItem >, ClassArray< LayerMaterial >, ClassArray< SplinePoint3D >, ClassArray< BaseNode >, ClassArray< ModelItem >, ClassArray< bcVec3 >, ClassArray< FacesCluster >, ClassArray< OneToolPreset >, ClassArray< OneVolumeTransform >, ClassArray< ItemsTree >, ClassArray< VolumeObject >, ClassArray< BasicDistortion >, ClassArray< Pt3D2 >, ClassArray< CurvElement2 >, ClassArray< ABOcTreeLevel >, ClassArray< FolderState >, ClassArray< my_test1 >, ClassArray< BaseWidget >, ClassArray< ExShaderParam >, ClassArray< GuideSection >, ClassArray< ShaderPreviewStrct >, ClassArray< BaseDrawingPrim >, ClassArray< OneFold >, ClassArray< RTUVSet >, ClassArray< ClassRef< BaseClass > >, ClassArray< StringsList >, ClassArray< MeasureElement >, ClassArray< OneRandomPen >, ClassArray< OnePreset >, ClassArray< ScrollParam >, ClassArray< CurveReference >, ClassArray< OneLayerInfo >, ClassArray< OneSubObject >, ClassArray< OneMaterial >, ClassArray< ImpUVSet2 >, ClassArray< RecoSample >, ClassArray< NaviEvent >, ClassArray< ExampleOfLoadSaveDataTo3BFileExtension::MyClassTest >, ClassArray< FolderRoot >, ClassArray< WindowPos >, ClassArray< RetopoGroup >, ClassArray< BaseEffectFlow >, ClassArray< FileEnabler >, ClassArray< One2DCurve >, ClassArray< VarStorage >, ClassArray< DbgLItem >, ClassArray< wCurvePoint >, ClassArray< OneMorphInfo >, ClassArray< psd_Layer >, ClassArray< SubFaceList >, ClassArray< MRenderTarget >, ClassArray< RenamePair >, ClassArray< SplinePoint3 >, ClassArray< DockLayoutElement >, ClassArray< Point3D >, ClassArray< CellsStorage >, ClassArray< CoreScriptTempItem >, ClassArray< JointPreview >, ClassArray< SplinePoint2 >, ClassArray< SplineCurve >, ClassArray< SubdWeights >, ClassArray< OneExportTexture >, ClassArray< DragNDropToolItem >, ClassArray< TempPt >, ClassArray< OneMtlInUVSet >, ClassArray< OneHotKey >, ClassArray< ExtraLight >, ClassArray< SphereOfInfluence >, ClassArray< ImpUV2 >, ClassArray< OneMtlLayer >, ClassArray< SplinePoint >, ClassArray< SliderState >, ClassArray< CustomLeftPanel >, ClassArray< cElement >, ClassArray< LwoNode >, ClassArray< ImpUVSet >, ClassArray< RetopoUVSet >, ClassArray< OneDrawnStroke >, ClassArray< LayerData >, ClassArray< CurvePrimitive >, ClassArray< KeptPolygon >, ClassArray< NodesCategory >, ClassArray< SymmetryState >, ClassArray< CurvedChunk >, ClassArray< BasePrim >, ClassArray< CameraShortcut >, ClassArray< VMapType >, and StringsList.

void BaseClass::DeleteDefaultSubFields	(	TagsList &	xml,
		void *	ClassPtr,
		void *	Extra = `NULL`
	)

inherited

Short form saving. Fields that are unchanged in comparison to default will be skipped in XML.

virtual int BaseClass::ExpandWith	(	const char *	ElmName,
		void *	base
	)

inlinevirtualinherited

Expand array with class ElmName.

Reimplemented in ClassRef< X >, ClassRef< BaseClass >, ClassPtr< X >, ClassPtr< BaseClass >, ClassPtr< VoxMethadata >, ClassPtr< BasicDistortion >, ClassPtr< OnePenStyle >, ClassPtr< CurvePrimitive >, ClassPtr< ModelPreview >, ClassPtr< BasePrim >, ClassArray< X >, ClassArray< TextItem >, ClassArray< BaseKnot >, ClassArray< IconicText >, ClassArray< BaseClass >, ClassArray< mitem >, ClassArray< PopupWindow >, ClassArray< OneQAItem >, ClassArray< LayerMaterial >, ClassArray< SplinePoint3D >, ClassArray< BaseNode >, ClassArray< ModelItem >, ClassArray< bcVec3 >, ClassArray< FacesCluster >, ClassArray< OneToolPreset >, ClassArray< OneVolumeTransform >, ClassArray< ItemsTree >, ClassArray< VolumeObject >, ClassArray< BasicDistortion >, ClassArray< Pt3D2 >, ClassArray< CurvElement2 >, ClassArray< ABOcTreeLevel >, ClassArray< FolderState >, ClassArray< my_test1 >, ClassArray< BaseWidget >, ClassArray< ExShaderParam >, ClassArray< GuideSection >, ClassArray< ShaderPreviewStrct >, ClassArray< BaseDrawingPrim >, ClassArray< OneFold >, ClassArray< RTUVSet >, ClassArray< ClassRef< BaseClass > >, ClassArray< StringsList >, ClassArray< MeasureElement >, ClassArray< OneRandomPen >, ClassArray< OnePreset >, ClassArray< ScrollParam >, ClassArray< CurveReference >, ClassArray< OneLayerInfo >, ClassArray< OneSubObject >, ClassArray< OneMaterial >, ClassArray< ImpUVSet2 >, ClassArray< RecoSample >, ClassArray< NaviEvent >, ClassArray< ExampleOfLoadSaveDataTo3BFileExtension::MyClassTest >, ClassArray< FolderRoot >, ClassArray< WindowPos >, ClassArray< RetopoGroup >, ClassArray< BaseEffectFlow >, ClassArray< FileEnabler >, ClassArray< One2DCurve >, ClassArray< VarStorage >, ClassArray< DbgLItem >, ClassArray< wCurvePoint >, ClassArray< OneMorphInfo >, ClassArray< psd_Layer >, ClassArray< SubFaceList >, ClassArray< MRenderTarget >, ClassArray< RenamePair >, ClassArray< SplinePoint3 >, ClassArray< DockLayoutElement >, ClassArray< Point3D >, ClassArray< CellsStorage >, ClassArray< CoreScriptTempItem >, ClassArray< JointPreview >, ClassArray< SplinePoint2 >, ClassArray< SplineCurve >, ClassArray< SubdWeights >, ClassArray< OneExportTexture >, ClassArray< DragNDropToolItem >, ClassArray< TempPt >, ClassArray< OneMtlInUVSet >, ClassArray< OneHotKey >, ClassArray< ExtraLight >, ClassArray< SphereOfInfluence >, ClassArray< ImpUV2 >, ClassArray< OneMtlLayer >, ClassArray< SplinePoint >, ClassArray< SliderState >, ClassArray< CustomLeftPanel >, ClassArray< cElement >, ClassArray< LwoNode >, ClassArray< ImpUVSet >, ClassArray< RetopoUVSet >, ClassArray< OneDrawnStroke >, ClassArray< LayerData >, ClassArray< CurvePrimitive >, ClassArray< KeptPolygon >, ClassArray< NodesCategory >, ClassArray< SymmetryState >, ClassArray< CurvedChunk >, ClassArray< BasePrim >, ClassArray< CameraShortcut >, and ClassArray< VMapType >.

void BaseClass::ForEach	(	const std::function< bool(BaseClassElement *el)> &	fn,
		bool	OnlyPointsers = `false`
	)

inherited

Calls function for each class member. This function used in _EACH ... _EACH_END cycle.

Parameters

fn	Function to call, usually lambda
OnlyPointsers	If true, stringual ID field of BaseClassElement will not be filled (for speed purposes).

virtual void BaseClass::FromStr ( const comms::cStr & bs )

virtualinherited

See Also: ToBS()

virtual bool BaseClass::FullCopy	(	const void *	SrcData,
		const void *	SrcDataExtra,
		BaseClass *	Dest,
		void *	DestData,
		void *	DstDataExtra,
		CECopyContext *	C
	)

virtualinherited

Fast copy from one BaseClass to another. Names and types correspondence used to copy.

Parameters

SrcData	Data data pointer
SrcDataExtra	Src extra
Dest	Destination class
DestData	Destination data
DstDataExtra	Destination extra
C	copy context

Returns: true if successful

Reimplemented in ClassRef< X >, ClassRef< BaseClass >, ClassPtr< X >, ClassPtr< BaseClass >, ClassPtr< VoxMethadata >, ClassPtr< BasicDistortion >, ClassPtr< OnePenStyle >, ClassPtr< CurvePrimitive >, ClassPtr< ModelPreview >, ClassPtr< BasePrim >, ClassArray< X >, ClassArray< TextItem >, ClassArray< BaseKnot >, ClassArray< IconicText >, ClassArray< BaseClass >, ClassArray< mitem >, ClassArray< PopupWindow >, ClassArray< OneQAItem >, ClassArray< LayerMaterial >, ClassArray< SplinePoint3D >, ClassArray< BaseNode >, ClassArray< ModelItem >, ClassArray< bcVec3 >, ClassArray< FacesCluster >, ClassArray< OneToolPreset >, ClassArray< OneVolumeTransform >, ClassArray< ItemsTree >, ClassArray< VolumeObject >, ClassArray< BasicDistortion >, ClassArray< Pt3D2 >, ClassArray< CurvElement2 >, ClassArray< ABOcTreeLevel >, ClassArray< FolderState >, ClassArray< my_test1 >, ClassArray< BaseWidget >, ClassArray< ExShaderParam >, ClassArray< GuideSection >, ClassArray< ShaderPreviewStrct >, ClassArray< BaseDrawingPrim >, ClassArray< OneFold >, ClassArray< RTUVSet >, ClassArray< ClassRef< BaseClass > >, ClassArray< StringsList >, ClassArray< MeasureElement >, ClassArray< OneRandomPen >, ClassArray< OnePreset >, ClassArray< ScrollParam >, ClassArray< CurveReference >, ClassArray< OneLayerInfo >, ClassArray< OneSubObject >, ClassArray< OneMaterial >, ClassArray< ImpUVSet2 >, ClassArray< RecoSample >, ClassArray< NaviEvent >, ClassArray< ExampleOfLoadSaveDataTo3BFileExtension::MyClassTest >, ClassArray< FolderRoot >, ClassArray< WindowPos >, ClassArray< RetopoGroup >, ClassArray< BaseEffectFlow >, ClassArray< FileEnabler >, ClassArray< One2DCurve >, ClassArray< VarStorage >, ClassArray< DbgLItem >, ClassArray< wCurvePoint >, ClassArray< OneMorphInfo >, ClassArray< psd_Layer >, ClassArray< SubFaceList >, ClassArray< MRenderTarget >, ClassArray< RenamePair >, ClassArray< SplinePoint3 >, ClassArray< DockLayoutElement >, ClassArray< Point3D >, ClassArray< CellsStorage >, ClassArray< CoreScriptTempItem >, ClassArray< JointPreview >, ClassArray< SplinePoint2 >, ClassArray< SplineCurve >, ClassArray< SubdWeights >, ClassArray< OneExportTexture >, ClassArray< DragNDropToolItem >, ClassArray< TempPt >, ClassArray< OneMtlInUVSet >, ClassArray< OneHotKey >, ClassArray< ExtraLight >, ClassArray< SphereOfInfluence >, ClassArray< ImpUV2 >, ClassArray< OneMtlLayer >, ClassArray< SplinePoint >, ClassArray< SliderState >, ClassArray< CustomLeftPanel >, ClassArray< cElement >, ClassArray< LwoNode >, ClassArray< ImpUVSet >, ClassArray< RetopoUVSet >, ClassArray< OneDrawnStroke >, ClassArray< LayerData >, ClassArray< CurvePrimitive >, ClassArray< KeptPolygon >, ClassArray< NodesCategory >, ClassArray< SymmetryState >, ClassArray< CurvedChunk >, ClassArray< BasePrim >, ClassArray< CameraShortcut >, ClassArray< VMapType >, StringsList, and Delimiter.

virtual int BaseClass::GetAmountOfElements ( )

virtualinherited

return complete amount of elements. Even invisible, masked and non-serialized elements will be counted

Reimplemented in ClassRef< X >, ClassRef< BaseClass >, ClassPtr< X >, ClassPtr< BaseClass >, ClassPtr< VoxMethadata >, ClassPtr< BasicDistortion >, ClassPtr< OnePenStyle >, ClassPtr< CurvePrimitive >, ClassPtr< ModelPreview >, ClassPtr< BasePrim >, ClassArray< X >, ClassArray< TextItem >, ClassArray< BaseKnot >, ClassArray< IconicText >, ClassArray< BaseClass >, ClassArray< mitem >, ClassArray< PopupWindow >, ClassArray< OneQAItem >, ClassArray< LayerMaterial >, ClassArray< SplinePoint3D >, ClassArray< BaseNode >, ClassArray< ModelItem >, ClassArray< bcVec3 >, ClassArray< FacesCluster >, ClassArray< OneToolPreset >, ClassArray< OneVolumeTransform >, ClassArray< ItemsTree >, ClassArray< VolumeObject >, ClassArray< BasicDistortion >, ClassArray< Pt3D2 >, ClassArray< CurvElement2 >, ClassArray< ABOcTreeLevel >, ClassArray< FolderState >, ClassArray< my_test1 >, ClassArray< BaseWidget >, ClassArray< ExShaderParam >, ClassArray< GuideSection >, ClassArray< ShaderPreviewStrct >, ClassArray< BaseDrawingPrim >, ClassArray< OneFold >, ClassArray< RTUVSet >, ClassArray< ClassRef< BaseClass > >, ClassArray< StringsList >, ClassArray< MeasureElement >, ClassArray< OneRandomPen >, ClassArray< OnePreset >, ClassArray< ScrollParam >, ClassArray< CurveReference >, ClassArray< OneLayerInfo >, ClassArray< OneSubObject >, ClassArray< OneMaterial >, ClassArray< ImpUVSet2 >, ClassArray< RecoSample >, ClassArray< NaviEvent >, ClassArray< ExampleOfLoadSaveDataTo3BFileExtension::MyClassTest >, ClassArray< FolderRoot >, ClassArray< WindowPos >, ClassArray< RetopoGroup >, ClassArray< BaseEffectFlow >, ClassArray< FileEnabler >, ClassArray< One2DCurve >, ClassArray< VarStorage >, ClassArray< DbgLItem >, ClassArray< wCurvePoint >, ClassArray< OneMorphInfo >, ClassArray< psd_Layer >, ClassArray< SubFaceList >, ClassArray< MRenderTarget >, ClassArray< RenamePair >, ClassArray< SplinePoint3 >, ClassArray< DockLayoutElement >, ClassArray< Point3D >, ClassArray< CellsStorage >, ClassArray< CoreScriptTempItem >, ClassArray< JointPreview >, ClassArray< SplinePoint2 >, ClassArray< SplineCurve >, ClassArray< SubdWeights >, ClassArray< OneExportTexture >, ClassArray< DragNDropToolItem >, ClassArray< TempPt >, ClassArray< OneMtlInUVSet >, ClassArray< OneHotKey >, ClassArray< ExtraLight >, ClassArray< SphereOfInfluence >, ClassArray< ImpUV2 >, ClassArray< OneMtlLayer >, ClassArray< SplinePoint >, ClassArray< SliderState >, ClassArray< CustomLeftPanel >, ClassArray< cElement >, ClassArray< LwoNode >, ClassArray< ImpUVSet >, ClassArray< RetopoUVSet >, ClassArray< OneDrawnStroke >, ClassArray< LayerData >, ClassArray< CurvePrimitive >, ClassArray< KeptPolygon >, ClassArray< NodesCategory >, ClassArray< SymmetryState >, ClassArray< CurvedChunk >, ClassArray< BasePrim >, ClassArray< CameraShortcut >, and ClassArray< VMapType >.

Referenced by CreateControlWithBaseClass().

virtual int BaseClass::GetAmountOfElementsInUI ( )

virtualinherited

return amount of elements represented in UI

virtual int BaseClass::GetAmountOfElementsInXML ( )

virtualinherited

return amount of elements taht will be stored in XML

virtual BaseClass* PopupWindow::GetClass ( )

inlinevirtual

Class to be edit in pop-up window.

By default this class will be edit.

virtual DWORD BaseClass::GetClassMask ( )

inlinevirtualinherited

Masking elements of class. Each member has mask. Element is serializable/visible only if (it's_mask & hosting_class_mask) != 0.

Reimplemented in UV_map_Tool, and VoxTreeBranch.

Referenced by CreateControlWithBaseClass().

virtual const char* BaseClass::GetClassName ( ) const

virtualinherited

return class name there if need. Usually you don't need, if you are using AUTONEW or SERIALIZE

Reimplemented in ClassRef< X >, ClassRef< BaseClass >, ClassPtr< X >, ClassPtr< BaseClass >, ClassPtr< VoxMethadata >, ClassPtr< BasicDistortion >, ClassPtr< OnePenStyle >, ClassPtr< CurvePrimitive >, ClassPtr< ModelPreview >, ClassPtr< BasePrim >, ClassArray< X >, ClassArray< TextItem >, ClassArray< BaseKnot >, ClassArray< IconicText >, ClassArray< BaseClass >, ClassArray< mitem >, ClassArray< PopupWindow >, ClassArray< OneQAItem >, ClassArray< LayerMaterial >, ClassArray< SplinePoint3D >, ClassArray< BaseNode >, ClassArray< ModelItem >, ClassArray< bcVec3 >, ClassArray< FacesCluster >, ClassArray< OneToolPreset >, ClassArray< OneVolumeTransform >, ClassArray< ItemsTree >, ClassArray< VolumeObject >, ClassArray< BasicDistortion >, ClassArray< Pt3D2 >, ClassArray< CurvElement2 >, ClassArray< ABOcTreeLevel >, ClassArray< FolderState >, ClassArray< my_test1 >, ClassArray< BaseWidget >, ClassArray< ExShaderParam >, ClassArray< GuideSection >, ClassArray< ShaderPreviewStrct >, ClassArray< BaseDrawingPrim >, ClassArray< OneFold >, ClassArray< RTUVSet >, ClassArray< ClassRef< BaseClass > >, ClassArray< StringsList >, ClassArray< MeasureElement >, ClassArray< OneRandomPen >, ClassArray< OnePreset >, ClassArray< ScrollParam >, ClassArray< CurveReference >, ClassArray< OneLayerInfo >, ClassArray< OneSubObject >, ClassArray< OneMaterial >, ClassArray< ImpUVSet2 >, ClassArray< RecoSample >, ClassArray< NaviEvent >, ClassArray< ExampleOfLoadSaveDataTo3BFileExtension::MyClassTest >, ClassArray< FolderRoot >, ClassArray< WindowPos >, ClassArray< RetopoGroup >, ClassArray< BaseEffectFlow >, ClassArray< FileEnabler >, ClassArray< One2DCurve >, ClassArray< VarStorage >, ClassArray< DbgLItem >, ClassArray< wCurvePoint >, ClassArray< OneMorphInfo >, ClassArray< psd_Layer >, ClassArray< SubFaceList >, ClassArray< MRenderTarget >, ClassArray< RenamePair >, ClassArray< SplinePoint3 >, ClassArray< DockLayoutElement >, ClassArray< Point3D >, ClassArray< CellsStorage >, ClassArray< CoreScriptTempItem >, ClassArray< JointPreview >, ClassArray< SplinePoint2 >, ClassArray< SplineCurve >, ClassArray< SubdWeights >, ClassArray< OneExportTexture >, ClassArray< DragNDropToolItem >, ClassArray< TempPt >, ClassArray< OneMtlInUVSet >, ClassArray< OneHotKey >, ClassArray< ExtraLight >, ClassArray< SphereOfInfluence >, ClassArray< ImpUV2 >, ClassArray< OneMtlLayer >, ClassArray< SplinePoint >, ClassArray< SliderState >, ClassArray< CustomLeftPanel >, ClassArray< cElement >, ClassArray< LwoNode >, ClassArray< ImpUVSet >, ClassArray< RetopoUVSet >, ClassArray< OneDrawnStroke >, ClassArray< LayerData >, ClassArray< CurvePrimitive >, ClassArray< KeptPolygon >, ClassArray< NodesCategory >, ClassArray< SymmetryState >, ClassArray< CurvedChunk >, ClassArray< BasePrim >, ClassArray< CameraShortcut >, ClassArray< VMapType >, StringsList, and Delimiter.

Referenced by ClassArray< VMapType >::CountObjects(), CreateControlWithBaseClass(), CurveModifier::GetTool(), ClassArray< VMapType >::SaveBin(), and ClassPtr< BasePrim >::SaveBin().

virtual int BaseClass::GetClassSize ( ) const

virtualinherited

return actual size of this class

virtual float PopupWindow::GetDefaultHeight ( )

inlinevirtual

Returns default window width.

virtual const char* PopupWindow::GetDefaultHotkey ( )

inlinevirtual

Get default hotkeys by default.

virtual cVec2 PopupWindow::GetDefaultPlacement ( )

inlinevirtual

Get default placement and size.

Returns cVec2( x, y ), x = 0..1 in workspace range, 0 - left, 1 - right, y = 0..1, 0 - top, 1 - bottom.

virtual float PopupWindow::GetDefaultWidth ( )

inlinevirtual

Returns default window width.

virtual bool BaseClass::GetElement	(	BaseClassElement &	res,
		int	idx,
		const void *	Ptr = `nullptr`,
		const void *	Extra = `nullptr`
	)

virtualinherited

The function returns complete information about the member by it's index. If you want to walk through all members use _EACH ... _EACH_END loop.

Parameters

res	All data gathered there
idx	Index of the member
Ptr	Pointer to data (if class is direcly castable it is equal to this, othervice it points to placement of data in memory). If NULL passed, this will be used
Extra	Extra data, used for enumerators and sliders (mostly)

Returns: return true if element exists and visible

Reimplemented in ClassRef< X >, ClassRef< BaseClass >, ClassPtr< X >, ClassPtr< BaseClass >, ClassPtr< VoxMethadata >, ClassPtr< BasicDistortion >, ClassPtr< OnePenStyle >, ClassPtr< CurvePrimitive >, ClassPtr< ModelPreview >, and ClassPtr< BasePrim >.

Referenced by CreateControlWithBaseClass().

bool BaseClass::GetElementByName	(	const char *	Name,
		void *	Ptr,
		void *	Extra,
		BaseClassElement &	res,
		bool	UI = `false`,
		bool	Serialize = `true`
	)

inherited

The function returns complete information about the member by it's name.

Parameters

Name	Name of the member
Ptr	Data ptr
Extra	Extra
res	All data gathered there

Returns: return true if element exists and visible

Referenced by CurvePrimitive::OnChangeMember().

virtual int PopupWindow::GetFixedHeight ( )

inlinevirtual

Returns nonzero value if you need fixed window height when called from Navi bar.

virtual int PopupWindow::GetFixedWidth ( )

inlinevirtual

Returns nonzero value if you need fixed window width when called from Navi bar.

virtual IconInfo PopupWindow::GetIcon ( )

inlinevirtual

Icon name to show in navi bar.

virtual IconInfo PopupWindow::GetIconInActivityBar ( )

inlinevirtual

returns the icon for the activity bar.

Icon is not permanent, this function called each frame to get current state of the icon.

Reimplemented in SmartMatWindow.

BaseClass* BaseClass::GetRoot ( )

inherited

BaseClass is like a tree, and you always can get the root of the tree using this function.

virtual DWORD PopupWindow::GetSaveMagic ( )

inlinevirtual

serialize the window data to the 3B file

virtual bool PopupWindow::GetSizeWhenTriggeredByHotkey ( cVec2 & size )

inlinevirtual

Resturn true and set special size when the window triggered by hokey.

Referenced by AutoShow().

virtual const char* PopupWindow::GetWindowID ( )

inlinevirtual

Window name to show in Windows->Popups and window header.

Reimplemented in SmartMatWindow.

Referenced by Register().

virtual double PopupWindow::GetWindowSortValue ( )

inlinevirtual

The bigger value returned, the lower position in windows list the window will get.

Returns: the value for windows sorting.

Reimplemented in SmartMatWindow.

virtual bool BaseClass::HandleKey ( int code )

inlinevirtualinherited

Editor will call next function when key pressed.

Returns: true if key handled, false if not.Return true if code == -1 (othervice callback will never be called later).

Referenced by CreateControlWithBaseClass().

bool PopupWindow::IsInDock ( )

check if window is in dock

virtual bool PopupWindow::KeepExpanded ( )

inlinevirtual

Return true if you want to expand class parameters on the full height (whenever possible) when class hashsumm changes.

virtual bool BaseClass::Load	(	TagsList &	xml,
		void *	ClassPtr,
		void *	Extra = `NULL`
	)

virtualinherited

Load the class from the XML structure.

Parameters

xml	The source XML
ClassPtr	The pointer to the data, equals to this if class is directly castable
Extra	Extra data pointer

Returns: true if successful

Reimplemented in ClassArray< X >, ClassArray< TextItem >, ClassArray< BaseKnot >, ClassArray< IconicText >, ClassArray< BaseClass >, ClassArray< mitem >, ClassArray< PopupWindow >, ClassArray< OneQAItem >, ClassArray< LayerMaterial >, ClassArray< SplinePoint3D >, ClassArray< BaseNode >, ClassArray< ModelItem >, ClassArray< bcVec3 >, ClassArray< FacesCluster >, ClassArray< OneToolPreset >, ClassArray< OneVolumeTransform >, ClassArray< ItemsTree >, ClassArray< VolumeObject >, ClassArray< BasicDistortion >, ClassArray< Pt3D2 >, ClassArray< CurvElement2 >, ClassArray< ABOcTreeLevel >, ClassArray< FolderState >, ClassArray< my_test1 >, ClassArray< BaseWidget >, ClassArray< ExShaderParam >, ClassArray< GuideSection >, ClassArray< ShaderPreviewStrct >, ClassArray< BaseDrawingPrim >, ClassArray< OneFold >, ClassArray< RTUVSet >, ClassArray< ClassRef< BaseClass > >, ClassArray< StringsList >, ClassArray< MeasureElement >, ClassArray< OneRandomPen >, ClassArray< OnePreset >, ClassArray< ScrollParam >, ClassArray< CurveReference >, ClassArray< OneLayerInfo >, ClassArray< OneSubObject >, ClassArray< OneMaterial >, ClassArray< ImpUVSet2 >, ClassArray< RecoSample >, ClassArray< NaviEvent >, ClassArray< ExampleOfLoadSaveDataTo3BFileExtension::MyClassTest >, ClassArray< FolderRoot >, ClassArray< WindowPos >, ClassArray< RetopoGroup >, ClassArray< BaseEffectFlow >, ClassArray< FileEnabler >, ClassArray< One2DCurve >, ClassArray< VarStorage >, ClassArray< DbgLItem >, ClassArray< wCurvePoint >, ClassArray< OneMorphInfo >, ClassArray< psd_Layer >, ClassArray< SubFaceList >, ClassArray< MRenderTarget >, ClassArray< RenamePair >, ClassArray< SplinePoint3 >, ClassArray< DockLayoutElement >, ClassArray< Point3D >, ClassArray< CellsStorage >, ClassArray< CoreScriptTempItem >, ClassArray< JointPreview >, ClassArray< SplinePoint2 >, ClassArray< SplineCurve >, ClassArray< SubdWeights >, ClassArray< OneExportTexture >, ClassArray< DragNDropToolItem >, ClassArray< TempPt >, ClassArray< OneMtlInUVSet >, ClassArray< OneHotKey >, ClassArray< ExtraLight >, ClassArray< SphereOfInfluence >, ClassArray< ImpUV2 >, ClassArray< OneMtlLayer >, ClassArray< SplinePoint >, ClassArray< SliderState >, ClassArray< CustomLeftPanel >, ClassArray< cElement >, ClassArray< LwoNode >, ClassArray< ImpUVSet >, ClassArray< RetopoUVSet >, ClassArray< OneDrawnStroke >, ClassArray< LayerData >, ClassArray< CurvePrimitive >, ClassArray< KeptPolygon >, ClassArray< NodesCategory >, ClassArray< SymmetryState >, ClassArray< CurvedChunk >, ClassArray< BasePrim >, ClassArray< CameraShortcut >, ClassArray< VMapType >, CurveModifier, StringsList, and KnotReference.

Referenced by CurveModifier::Load(), ClassArray< VMapType >::Load(), and CurvePrimitive::OnChangeMember().

virtual void BaseClass::LoadBin	(	void *	Data,
		void *	Extra,
		BinStream *	In,
		Enumerator *	ExDictionary
	)

virtualinherited

Load the class from the memory. Use only for temporary storage in memory!!!

Parameters

Data	Pointer to the class data
Extra	Extra data
In	binary stream to read data from
ExDictionary	Additional dictionary

Reimplemented in ClassRef< X >, ClassRef< BaseClass >, ClassPtr< X >, ClassPtr< BaseClass >, ClassPtr< VoxMethadata >, ClassPtr< BasicDistortion >, ClassPtr< OnePenStyle >, ClassPtr< CurvePrimitive >, ClassPtr< ModelPreview >, ClassPtr< BasePrim >, ClassArray< X >, ClassArray< TextItem >, ClassArray< BaseKnot >, ClassArray< IconicText >, ClassArray< BaseClass >, ClassArray< mitem >, ClassArray< PopupWindow >, ClassArray< OneQAItem >, ClassArray< LayerMaterial >, ClassArray< SplinePoint3D >, ClassArray< BaseNode >, ClassArray< ModelItem >, ClassArray< bcVec3 >, ClassArray< FacesCluster >, ClassArray< OneToolPreset >, ClassArray< OneVolumeTransform >, ClassArray< ItemsTree >, ClassArray< VolumeObject >, ClassArray< BasicDistortion >, ClassArray< Pt3D2 >, ClassArray< CurvElement2 >, ClassArray< ABOcTreeLevel >, ClassArray< FolderState >, ClassArray< my_test1 >, ClassArray< BaseWidget >, ClassArray< ExShaderParam >, ClassArray< GuideSection >, ClassArray< ShaderPreviewStrct >, ClassArray< BaseDrawingPrim >, ClassArray< OneFold >, ClassArray< RTUVSet >, ClassArray< ClassRef< BaseClass > >, ClassArray< StringsList >, ClassArray< MeasureElement >, ClassArray< OneRandomPen >, ClassArray< OnePreset >, ClassArray< ScrollParam >, ClassArray< CurveReference >, ClassArray< OneLayerInfo >, ClassArray< OneSubObject >, ClassArray< OneMaterial >, ClassArray< ImpUVSet2 >, ClassArray< RecoSample >, ClassArray< NaviEvent >, ClassArray< ExampleOfLoadSaveDataTo3BFileExtension::MyClassTest >, ClassArray< FolderRoot >, ClassArray< WindowPos >, ClassArray< RetopoGroup >, ClassArray< BaseEffectFlow >, ClassArray< FileEnabler >, ClassArray< One2DCurve >, ClassArray< VarStorage >, ClassArray< DbgLItem >, ClassArray< wCurvePoint >, ClassArray< OneMorphInfo >, ClassArray< psd_Layer >, ClassArray< SubFaceList >, ClassArray< MRenderTarget >, ClassArray< RenamePair >, ClassArray< SplinePoint3 >, ClassArray< DockLayoutElement >, ClassArray< Point3D >, ClassArray< CellsStorage >, ClassArray< CoreScriptTempItem >, ClassArray< JointPreview >, ClassArray< SplinePoint2 >, ClassArray< SplineCurve >, ClassArray< SubdWeights >, ClassArray< OneExportTexture >, ClassArray< DragNDropToolItem >, ClassArray< TempPt >, ClassArray< OneMtlInUVSet >, ClassArray< OneHotKey >, ClassArray< ExtraLight >, ClassArray< SphereOfInfluence >, ClassArray< ImpUV2 >, ClassArray< OneMtlLayer >, ClassArray< SplinePoint >, ClassArray< SliderState >, ClassArray< CustomLeftPanel >, ClassArray< cElement >, ClassArray< LwoNode >, ClassArray< ImpUVSet >, ClassArray< RetopoUVSet >, ClassArray< OneDrawnStroke >, ClassArray< LayerData >, ClassArray< CurvePrimitive >, ClassArray< KeptPolygon >, ClassArray< NodesCategory >, ClassArray< SymmetryState >, ClassArray< CurvedChunk >, ClassArray< BasePrim >, ClassArray< CameraShortcut >, ClassArray< VMapType >, CurveModifier, StringsList, and Delimiter.

Referenced by CurveModifier::LoadBin(), and ClassArray< VMapType >::LoadBin().

virtual BaseClass* BaseClass::new_element ( ) const

virtualinherited

construct pointer to class of the same type like this. Elements will not be copied into the new place

Referenced by ClassArray< VMapType >::ExpandWith(), and ClassPtr< BasePrim >::ExpandWith().

virtual bool BaseClass::OnAcceptDrag	(	BaseClass *	DraggedItemParent,
		const char *	DraggedMemberID,
		const char *	AcceptorMemberID,
		iRct	MyRect
	)

inlinevirtualinherited

See Also: CanBeDragged(), CanAcceptDrag(), OnStartDrag(), OnEndDrag()

Reimplemented in ItemsTree.

virtual void PopupWindow::OnActivate ( )

inlinevirtual

Called when Show or PopUp or Window->Popups->... called.

virtual bool BaseClass::OnChangeMember	(	BaseClass *	MembClass,
		void *	MembPtr,
		void *	MembExtra,
		const char *	MembName
	)

inlinevirtualinherited

Editor will call it every time when member changes and editor is able to recognise it.

Returns: The value doesn't matter.

See Also: BeforeChangeMember()

Reimplemented in UV_map_Tool, VoxTreeBranch, OneFacture, QuadragulationTask, and CurvePrimitive.

virtual void PopupWindow::OnClose ( )

inlinevirtual

Called when user closes the window or Close() called.

virtual BaseWidget* BaseClass::OnCreateControlFromScratch	(	const ClassEditorContext &	Context,
		Rct &	Rect
	)

inlinevirtualinherited

Create completely own control for ClassEditor.

Override it when need to create completely own class editor control.

Parameters

[in]	FieldName	is how the object registered.
[out]	Rect	is rectangle to place control, may be modified by this function if need.
[in]	Ptr	is pointer to data, if class suports direct casting it is equal to "this".

Returns: The function should return control (BaseWidget*) to place in UI

See Also: One2DCurve::OnModifyControl()

Reimplemented in ModelPreview.

Referenced by CreateControlWithBaseClass().

virtual bool BaseClass::OnEndDrag ( const char * MemberID )

inlinevirtualinherited

See Also: CanBeDragged(), CanAcceptDrag(), OnStartDrag(), OnAcceptDrag()

Reimplemented in ItemsTree.

virtual void BaseClass::OnModifyControl	(	const char *	FieldName,
		BaseWidget *	W,
		ClassEditorContext &	Context
	)

inlinevirtualinherited

Call for every member of registered class registered class.

Override it when you need to modify default class editor control. This routine allows to modify class editor controls without rewriting from scratch. Build controls in the W.

See Also: MultiMtlLayer::OnModifyControl(); RetopoGroup::OnModifyControl(); VoxTreeBranch::OnModifyControl()

Reimplemented in VoxTreeBranch, and ItemsTree.

Referenced by CreateControlWithBaseClass().

virtual void PopupWindow::OnNewScene ( )

inlinevirtual

called when New scene triggered

virtual bool BaseClass::OnStartDrag ( const char * MemberID )

inlinevirtualinherited

See Also: CanBeDragged(), CanAcceptDrag(), OnEndDrag(), OnAcceptDrag()

Reimplemented in ItemsTree.

void PopupWindow::PopUp ( )

Pop-up under cursor for temporary showing.

void PopupWindow::PopUpNearRect	(	const Rct &	R,
		int	Xalign,
		int	Yalign
	)

Pop-up near rectangle. X/Y alingn: 0:Left, 1:Center, 2:Right.

virtual float PopupWindow::PresentInActivityBar ( )

inlinevirtual

Is it present in Activity (top right list of active elements like current pen, material, stencil) panel?

Returns priory of presence. Lower value means presence in the left side. 0 means that window is not present in activity bar.

Reimplemented in SmartMatWindow.

virtual int PopupWindow::PresentInNaviBar ( )

inlinevirtual

Is it present in Top Navigation Bar?

Returns non-zero position of icon from the left.

virtual int PopupWindow::PresentInWindowsList ( )

inlinevirtual

Is it present in Windows->Popups?

Returns nonzero value - preferred position from the top in windows list, returns big value to place in the bottom.

Reimplemented in SmartMatWindow.

Referenced by Register().

virtual void PopupWindow::Process ( )

inlinevirtual

Called each frame.

virtual bool BaseClass::ProcessInEditor ( BaseClass * Parent )

inlinevirtualinherited

Editor will call next function always when it is visible in tree. Return true if overriden.

Reimplemented in OneFacture, and CurvePrimitive.

Referenced by CreateControlWithBaseClass().

virtual bool BaseClass::ReadFromFile ( const char * Name )

virtualinherited

Save the object to file or binary stream. Example.

MyClass C;
MyClass C1;
// to stream
MemoryBinStream BS;
C.ToBS(BS, true);
// copy from C to C1
C1.FromBS(BS);
// to file
C.WriteToFile("file.xml");
C1.ReadFromFile("file.xml");
// to string
cStr s;
C.ToStr(s);
C1.FromStr(s);

void PopupWindow::RefreshUI ( )

Refresh.

void PopupWindow::Register ( PopupWindow * win )

static

Registering window in system.

References GetWindowID(), PresentInWindowsList(), ui_comment(), and ui_element().

virtual void BaseClass::RegisterMembers ( )

virtualinherited

Reload this function to register members. Usually you don't need to do this if you are using any of SERIALIZE methods of registration.

virtual void BaseClass::reset_class ( void * DataPtr = nullptr )

virtualinherited

Clearing all registered content of the class. If DataPtr is nullptr, this class will be cleared.

Reimplemented in ClassRef< X >, ClassRef< BaseClass >, ClassPtr< X >, ClassPtr< BaseClass >, ClassPtr< VoxMethadata >, ClassPtr< BasicDistortion >, ClassPtr< OnePenStyle >, ClassPtr< CurvePrimitive >, ClassPtr< ModelPreview >, ClassPtr< BasePrim >, ClassArray< X >, ClassArray< TextItem >, ClassArray< BaseKnot >, ClassArray< IconicText >, ClassArray< BaseClass >, ClassArray< mitem >, ClassArray< PopupWindow >, ClassArray< OneQAItem >, ClassArray< LayerMaterial >, ClassArray< SplinePoint3D >, ClassArray< BaseNode >, ClassArray< ModelItem >, ClassArray< bcVec3 >, ClassArray< FacesCluster >, ClassArray< OneToolPreset >, ClassArray< OneVolumeTransform >, ClassArray< ItemsTree >, ClassArray< VolumeObject >, ClassArray< BasicDistortion >, ClassArray< Pt3D2 >, ClassArray< CurvElement2 >, ClassArray< ABOcTreeLevel >, ClassArray< FolderState >, ClassArray< my_test1 >, ClassArray< BaseWidget >, ClassArray< ExShaderParam >, ClassArray< GuideSection >, ClassArray< ShaderPreviewStrct >, ClassArray< BaseDrawingPrim >, ClassArray< OneFold >, ClassArray< RTUVSet >, ClassArray< ClassRef< BaseClass > >, ClassArray< StringsList >, ClassArray< MeasureElement >, ClassArray< OneRandomPen >, ClassArray< OnePreset >, ClassArray< ScrollParam >, ClassArray< CurveReference >, ClassArray< OneLayerInfo >, ClassArray< OneSubObject >, ClassArray< OneMaterial >, ClassArray< ImpUVSet2 >, ClassArray< RecoSample >, ClassArray< NaviEvent >, ClassArray< ExampleOfLoadSaveDataTo3BFileExtension::MyClassTest >, ClassArray< FolderRoot >, ClassArray< WindowPos >, ClassArray< RetopoGroup >, ClassArray< BaseEffectFlow >, ClassArray< FileEnabler >, ClassArray< One2DCurve >, ClassArray< VarStorage >, ClassArray< DbgLItem >, ClassArray< wCurvePoint >, ClassArray< OneMorphInfo >, ClassArray< psd_Layer >, ClassArray< SubFaceList >, ClassArray< MRenderTarget >, ClassArray< RenamePair >, ClassArray< SplinePoint3 >, ClassArray< DockLayoutElement >, ClassArray< Point3D >, ClassArray< CellsStorage >, ClassArray< CoreScriptTempItem >, ClassArray< JointPreview >, ClassArray< SplinePoint2 >, ClassArray< SplineCurve >, ClassArray< SubdWeights >, ClassArray< OneExportTexture >, ClassArray< DragNDropToolItem >, ClassArray< TempPt >, ClassArray< OneMtlInUVSet >, ClassArray< OneHotKey >, ClassArray< ExtraLight >, ClassArray< SphereOfInfluence >, ClassArray< ImpUV2 >, ClassArray< OneMtlLayer >, ClassArray< SplinePoint >, ClassArray< SliderState >, ClassArray< CustomLeftPanel >, ClassArray< cElement >, ClassArray< LwoNode >, ClassArray< ImpUVSet >, ClassArray< RetopoUVSet >, ClassArray< OneDrawnStroke >, ClassArray< LayerData >, ClassArray< CurvePrimitive >, ClassArray< KeptPolygon >, ClassArray< NodesCategory >, ClassArray< SymmetryState >, ClassArray< CurvedChunk >, ClassArray< BasePrim >, ClassArray< CameraShortcut >, ClassArray< VMapType >, and StringsList.

virtual void BaseClass::Save	(	TagsList &	xml,
		void *	ClassPtr,
		void *	Extra = `NULL`
	)

virtualinherited

Save class to the XML structure.

Parameters

xml	The result
ClassPtr	The pointer to the data, equals to this if class is directly castable
Extra	Extra data pointer

Reimplemented in CurveModifier, StringsList, and KnotReference.

Referenced by CurvePrimitive::OnChangeMember(), and CurveModifier::Save().

virtual void BaseClass::SaveBin	(	void *	Data,
		void *	Extra,
		BinStream *	Out,
		Enumerator *	ExDictionary,
		Enumerator *	SkipList
	)

virtualinherited

Save in binaly form. Use only for temporary storage in memory!!!

Parameters

Data	data pointer
Extra	extra pointer
Out	Output stream
ExDictionary	Dictionary for enumerators
SkipList	Skip list for enumerators

Reimplemented in ClassRef< X >, ClassRef< BaseClass >, ClassPtr< X >, ClassPtr< BaseClass >, ClassPtr< VoxMethadata >, ClassPtr< BasicDistortion >, ClassPtr< OnePenStyle >, ClassPtr< CurvePrimitive >, ClassPtr< ModelPreview >, ClassPtr< BasePrim >, ClassArray< X >, ClassArray< TextItem >, ClassArray< BaseKnot >, ClassArray< IconicText >, ClassArray< BaseClass >, ClassArray< mitem >, ClassArray< PopupWindow >, ClassArray< OneQAItem >, ClassArray< LayerMaterial >, ClassArray< SplinePoint3D >, ClassArray< BaseNode >, ClassArray< ModelItem >, ClassArray< bcVec3 >, ClassArray< FacesCluster >, ClassArray< OneToolPreset >, ClassArray< OneVolumeTransform >, ClassArray< ItemsTree >, ClassArray< VolumeObject >, ClassArray< BasicDistortion >, ClassArray< Pt3D2 >, ClassArray< CurvElement2 >, ClassArray< ABOcTreeLevel >, ClassArray< FolderState >, ClassArray< my_test1 >, ClassArray< BaseWidget >, ClassArray< ExShaderParam >, ClassArray< GuideSection >, ClassArray< ShaderPreviewStrct >, ClassArray< BaseDrawingPrim >, ClassArray< OneFold >, ClassArray< RTUVSet >, ClassArray< ClassRef< BaseClass > >, ClassArray< StringsList >, ClassArray< MeasureElement >, ClassArray< OneRandomPen >, ClassArray< OnePreset >, ClassArray< ScrollParam >, ClassArray< CurveReference >, ClassArray< OneLayerInfo >, ClassArray< OneSubObject >, ClassArray< OneMaterial >, ClassArray< ImpUVSet2 >, ClassArray< RecoSample >, ClassArray< NaviEvent >, ClassArray< ExampleOfLoadSaveDataTo3BFileExtension::MyClassTest >, ClassArray< FolderRoot >, ClassArray< WindowPos >, ClassArray< RetopoGroup >, ClassArray< BaseEffectFlow >, ClassArray< FileEnabler >, ClassArray< One2DCurve >, ClassArray< VarStorage >, ClassArray< DbgLItem >, ClassArray< wCurvePoint >, ClassArray< OneMorphInfo >, ClassArray< psd_Layer >, ClassArray< SubFaceList >, ClassArray< MRenderTarget >, ClassArray< RenamePair >, ClassArray< SplinePoint3 >, ClassArray< DockLayoutElement >, ClassArray< Point3D >, ClassArray< CellsStorage >, ClassArray< CoreScriptTempItem >, ClassArray< JointPreview >, ClassArray< SplinePoint2 >, ClassArray< SplineCurve >, ClassArray< SubdWeights >, ClassArray< OneExportTexture >, ClassArray< DragNDropToolItem >, ClassArray< TempPt >, ClassArray< OneMtlInUVSet >, ClassArray< OneHotKey >, ClassArray< ExtraLight >, ClassArray< SphereOfInfluence >, ClassArray< ImpUV2 >, ClassArray< OneMtlLayer >, ClassArray< SplinePoint >, ClassArray< SliderState >, ClassArray< CustomLeftPanel >, ClassArray< cElement >, ClassArray< LwoNode >, ClassArray< ImpUVSet >, ClassArray< RetopoUVSet >, ClassArray< OneDrawnStroke >, ClassArray< LayerData >, ClassArray< CurvePrimitive >, ClassArray< KeptPolygon >, ClassArray< NodesCategory >, ClassArray< SymmetryState >, ClassArray< CurvedChunk >, ClassArray< BasePrim >, ClassArray< CameraShortcut >, ClassArray< VMapType >, CurveModifier, StringsList, and Delimiter.

Referenced by CurveModifier::SaveBin(), ClassArray< VMapType >::SaveBin(), and ClassPtr< BasePrim >::SaveBin().

virtual void BaseClass::SetParent ( BaseClass * Parent )

virtualinherited

set parent recursively

Referenced by VoxTreeBranch::Add(), and ClassArray< VMapType >::ExpandWith().

void BaseClass::SetParents ( )

inherited

set parents to this for all child members

Referenced by CreateControlWithBaseClass().

void BaseClass::SetParentsSafe ( )

inherited

set parents to this for all child members, each child will be tested for validity

virtual bool BaseClass::ShouldSaveInShortForm ( )

inlinevirtualinherited

Return true if class should be saved in short form mandatory.

void PopupWindow::Show ( )

Show the window if it is hidden.

virtual void BaseClass::SimplySetParent ( BaseClass * Parent )

virtualinherited

set parent directly to this, not affecting members

virtual void BaseClass::UpdateHash	(	HashSummator &	S,
		void *	data = `nullptr`,
		void *	extra = `nullptr`
	)

virtualinherited

returns hash value dependent on data fields of this class

Parameters

data	Data ptr pointer to data
extra	Extra ptr pointer to methadata

Returns: Hash value returns some value dependent on the class inner data. Usually only serializable data influences on th return value.

Reimplemented in VoxTreeBranch, StringsList, and ItemsTree.

Referenced by ClassArray< VMapType >::CountObjects().

template<class Type >

bool BaseClass::valid ( ) const

inlineinherited

call it to check if this BaseClass pointer is valid

References BaseClass::pmutex, and BaseClass::presence.

Referenced by RegisterVoxHelper::clearScene(), and CreateControlWithBaseClass().

Member Data Documentation

DWORD BaseClass::_ClassMask

protectedinherited

Result of GetClassMask() written there. GetClassMask() is not const, so can't use it in const functions. The field introduced to use masking in const functions.

const char* BaseClass::CurrentSaveFile

staticinherited

If user triggers saving class to file, last filename stored there.

BaseClass* BaseClass::ParentBC

protectedinherited

pointer to the parent class in the tree

std::mutex* BaseClass::pmutex

staticprotectedinherited

mutex for register_this / remove_this

Referenced by BaseClass::valid().

uni_hash<_empty, cPtrDiff, (1 << 18), 2048>* BaseClass::presence

staticprotectedinherited

each BaseClass registered in this list

Referenced by BaseClass::valid().

The documentation for this class was generated from the following files:

3d-coat/3D-CoatV4/3D-Coat/PopupWindows.h
3d-coat/3D-CoatV4/3D-Coat/PopupWindows.cpp

Public Member Functions

Static Public Member Functions

Static Public Attributes

Protected Attributes

Static Protected Attributes

Detailed Description

Member Function Documentation

Member Data Documentation