C3D Toolkit  Kernel - 117982, Vision - 2.9.2.2
VSN::BoundingBoxRepBase Class Reference

BoundingBoxRepBase class is a base class for representations of a bounding box and serves for displaying informational graph size in a scene and outputting numerical values of all axes in the form of a scale. More...

#include <vsn_boundingboxrep.h>

+ Inheritance diagram for VSN::BoundingBoxRepBase:
+ Collaboration diagram for VSN::BoundingBoxRepBase:

Public Member Functions

virtual ~BoundingBoxRepBase ()
 Destructor.
 
bool IsVisibleBoundingBox () const
 Returns visibility of the BoundingBox.
 
void SetVisibleBoundingBox (bool visible)
 Sets visibility of the BoundingBox.
 
bool IsVisibleAxis (AxisOrientation orientation) const
 Returns visibility of the specified axis.
 
void SetVisibleAxis (AxisOrientation orientation, bool visible)
 Sets visibility of the specified axis.
 
bool IsVisibleTips (AxisOrientation orientation) const
 Returns visibility of the specified axis end.
 
void SetVisibleTips (AxisOrientation orientation, bool visible)
 Sets visibility of the specified axis end.
 
bool IsVisibleLabels (AxisOrientation orientation) const
 Returns visibility of the specified axis label text.
 
void SetVisibleLabels (AxisOrientation orientation, bool visible)
 Sets visibility of the specified axis label text.
 
bool IsReversedAxis (AxisOrientation orientation) const
 Returns a reversed specified axis.
 
void SetReversedAxis (AxisOrientation orientation, bool bEnabled)
 Sets a reversed specified axis.
 
bool IsAutoAdjustOrigin (AxisOrientation orientation) const
 Returns a flag of matching origin to world. If true, origin matches to world.
 
void SetAutoAdjustOrigin (AxisOrientation orientation, bool bAuto)
 Sets a flag of matching origin to world. If true, origin matches to world.
 
int GetSegmentCount (AxisOrientation orientation) const
 Returns a quantity of scale lines by the specified axis.
 
void SetSegmentCount (AxisOrientation orientation, int count)
 Sets a quantity of scale lines by the specified axis.
 
float GetTipSize (AxisOrientation orientation) const
 Returns a size of tip by the specified axis.
 
void SetTipSize (AxisOrientation orientation, float size)
 Sets a size of tip by the specified axis.
 
float GetSegmentSize (AxisOrientation orientation) const
 Returns a size of scale lines by the specified axis.
 
void SetSegmentSize (AxisOrientation orientation, float size)
 Sets a size of scale lines by the specified axis.
 
int GetFormatPrecision (AxisOrientation orientation) const
 Returns format of displaying values by the specified axis.
 
void SetFormatPrecision (AxisOrientation orientation, int precision)
 Sets format of displaying values by the specified axis.
 
float GetBoundingBoxEdgeWidth () const
 Returns a thickness of bounding box edge.
 
void SetBoundingBoxEdgeWidth (float width)
 Sets a thickness of bounding box edge.
 
float GetAxisThickness (AxisOrientation orientation) const
 Returns a thickness of axis.
 
void SetAxisThickness (AxisOrientation orientation, float width)
 Sets a thickness of axis.
 
bool IsDimensionVisible () const
 Returns visibility of a bounding box size.
 
void SetDimensionVisible (bool bVisible)
 Sets visibility of a bounding box size.
 
Color GetColorDimension () const
 Returns size color.
 
void SetColorDimension (const Color &color)
 Sets size color.
 
Color GetColorAxis (AxisOrientation orientation) const
 Returns a color of the specified axis.
 
void SetColorAxis (AxisOrientation orientation, const Color &color)
 Sets a color of the specified axis.
 
Color GetColorLabels (AxisOrientation orientation) const
 Returns a text color of the specified axis.
 
void SetColorLabels (AxisOrientation orientation, const Color &color)
 Sets a text color of the specified axis.
 
uint GetFontSizeLabels (AxisOrientation orientation) const
 Returns a font size of the specified axis.
 
void SetFontSizeLabels (AxisOrientation orientation, uint size)
 Sets a font size of the specified axis.
 
const FontGetFontLabels (AxisOrientation orientation) const
 Get the font of the text.
 
void SetFontLabels (AxisOrientation orientation, const Font &font)
 Set the font of the text.
 
void SetFontLabels (const Font &font)
 Set the font of the text.
 
bool GetScaleLabels (AxisOrientation orientation) const
 Text scaling on/off.
 
float GetThicknessAxis (AxisOrientation orientation) const
 Returns a Thickness of the specified axis.
 
void SetThicknessAxis (AxisOrientation orientation, float thickness)
 Sets a thickness of the specified axis.
 
BoxVertex GetAxesOrigin () const
 Get axes origin.
 
void SetAxesOrigin (const BoxVertex &origin)
 Set axes origin.
 
- Public Member Functions inherited from VSN::GeometryRep
 GeometryRep (Node *pParent=nullptr)
 Default constructor.
 
 GeometryRep (Geometry *pGeometry, Node *pParent=nullptr)
 Constructor by geometry parameters of the object.
 
virtual ~GeometryRep ()
 Destructor.
 
bool IsReferenceEmpty () const
 Checks if reference is empty.
 
bool IsLoaded () const
 Checks if representation is loaded.
 
const StringGetNameRep () const
 Returns representation name.
 
void SetNameRep (const String &name)
 Sets representation name.
 
GeometryGetGeomByKey (const NodeKey &key) const
 Returns geometry data by unique key.
 
GeometryGetGeomAt (size_t index) const
 Returns geometry data by index.
 
const ObjectList< Geometry * > & GetGeomList () const
 Returns geometry data list.
 
size_t GetGeometryCount () const
 Returns body count.
 
virtual bool IsEmpty () const
 True if representation array is empty.
 
bool IsBoundingBoxValid () const
 True if bounding box is valid.
 
MbCube GetBoundingBox () const
 Returns bounding box of representation.
 
bool IsGeometryInRep (Geometry *pGeom)
 True if representation contains geometry data.
 
size_t GetFaceCount () const
 Returns face count.
 
size_t GetVertexCount () const
 Returns vertex count.
 
size_t GetMaterialCount () const
 Returns material count.
 
std::set< Material * > GetMaterials () const
 Returns set of materials.
 
float GetVolume () const
 Returns representation volume.
 
void AddGeometry (Geometry *pGeom)
 Adds geometry data to the representation.
 
void DeleteEmptyGeometry ()
 Deletes empty geometry data and update materials.
 
void Clear ()
 Deletes all geometry data.
 
void ReverseNormals ()
 Reverses direction of all geometry normals.
 
virtual void ReplaceRep (GeometryRep *pRep)
 Replaces the representation.
 
void ReplaceMaterialById (const NodeKey &oldKey, Material *pMaterial)
 Replaces the specified material.
 
void TransformGeometriesByMatrix (const Matrix3DF &matrix)
 Transforms mesh vertices by given matrix.
 
virtual GeometryRepoperator= (const GeometryRep &)
 Assignment operator.
 
- Public Member Functions inherited from VSN::Node
 Node (Node *pParent=nullptr)
 Constructor with parent.
 
virtual ~Node ()
 Destructor.
 
NodeKey GetUniqueKey () const
 Returns key identifing Node instance.
 
void SetUniqueKey (const NodeKey &key)
 Sets the unique key for the instance.
 
NodeKey GetCustomKey () const
 Returns custom key identifing Node instance.
 
void SetCustomKey (const NodeKey &key)
 Sets the custom unique key for the instance.
 
NodeGetParentNode () const
 Returns pointer to the parent object or nullptr if no parent.
 
bool IsEnabled () const
 Returns the Node enabled flag. By default, the flag is always on.
 
ObjectList< Node * > GetChildNodes () const
 Return an array of child nodes for this node.
 
void SetParent (Node *pParent)
 Sets parent object to the object.
 
bool IsNotificationsBlocked () const
 True if notifications are blocked, otherwise, False.
 
bool SetBlockNotifications (bool block)
 Sets blocking of notifications and returns the previous blocking value.
 
- Public Member Functions inherited from VSN::Object
 Object (Object *pParent=nullptr)
 Default constructor. More...
 
virtual ~Object ()
 Destructor.
 
void SetParent (Object *pParent)
 NO TRANSLATION.
 
MutexGetMutex ()
 Object mutex.
 
String GetObjectName () const
 Returns name.
 
void SetObjectName (const String &name)
 Sets name.
 
bool IsControlType () const
 TRANSLATION.
 
ObjectGetParent () const
 NO TRANSLATION.
 
Variant GetProperty (const String &name) const
 NO TRANSLATION.
 
bool IsSignalsBlocked () const
 NO TRANSLATION.
 
bool SetBlockSignals (bool bBlock)
 NO TRANSLATION.
 
void AddEventListener (Object *pObject)
 NO TRANSLATION.
 
void RemoveEventListener (Object *pObject)
 NO TRANSLATION.
 
ObjectGetSender () const
 NO TRANSLATION.
 
Thread * GetThread () const
 NO TRANSLATION.
 
void BindWithThread (Thread *thread)
 NO TRANSLATION.
 
int StartTimer (int interval, TimerType timerType=tt_CoarseTimer)
 NO TRANSLATION.
 
void KillTimer (int id)
 NO TRANSLATION.
 
const ObjectList< Object * > & GetChildren () const
 NO TRANSLATION.
 
template<typename T >
FindChild (const String &objName=String()) const
 NO TRANSLATION.
 
template<typename T >
ObjectList< T > FindChildren (const String &objName=String(), VSN::ChildFindingPolicies policies=VSN::FindAllNestedChildren) const
 NO TRANSLATION.
 
- Public Member Functions inherited from VSN::BasicObject
 BasicObject ()
 Default constructor.
 
virtual ~BasicObject ()
 Destructor.
 

Protected Member Functions

 BoundingBoxRepBase (BoundingBoxGeometryBase *boxObject)
 For internal use.
 
- Protected Member Functions inherited from VSN::GeometryRep
 GeometryRep (GeometryRepPrivate &dd, Node *parent=nullptr)
 Signal about the end of rebuilding the whole geometry. More...
 
virtual void SceneModificationEvent (const std::shared_ptr< SceneModification > &modification) override
 The function is called in case of scene being modified.
 
- Protected Member Functions inherited from VSN::Node
 Node (NodePrivate &dd, Node *pParent)
 Sets the node enable flag. More...
 

Detailed Description

BoundingBoxRepBase class is a base class for representations of a bounding box and serves for displaying informational graph size in a scene and outputting numerical values of all axes in the form of a scale.

BoundingBoxRepBase class has a set of useful functions with which you can change a thickness of axis lines, change their color. BoundingBoxRep class gives an opportunity to set a view of scale displaying, its direction, and also visibility. There is a capability of setting origin, a match of origin to world and vector origin of axis direction.


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