FreeCAD C++
Public Member Functions | Static Public Member Functions | Public Attributes | Protected Member Functions | List of all members
App::OriginGroupExtension Class Reference

#include <App/OriginGroupExtension.h>

Detailed Description

Represents an abstract placeable group of objects with an associated Origin

Public Member Functions

App::OrigingetOrigin () const
 Returns the origin link or throws an exception.
 
virtual const char * getViewProviderName () const
 returns the type name of the ViewProvider
 
virtual short extensionMustExecute () override
 Returns true on changing OriginFeature set.
 
- Public Member Functions inherited from App::GeoFeatureGroupExtension
virtual void transformPlacement (const Base::Placement &transform)
 transformPlacement applies transform to placement of this shape. Override this function to propagate the change of placement to base features. More...
 
 GeoFeatureGroupExtension (void)
 Constructor.
 
Base::Placement globalGroupPlacement ()
 Calculates the global placement of this group. More...
 

Static Public Member Functions

static DocumentObjectgetGroupOfObject (const DocumentObject *obj)
 
- Static Public Member Functions inherited from App::GeoFeatureGroupExtension
static DocumentObjectgetGroupOfObject (const DocumentObject *obj)
 
static bool isNonGeoGroup (const DocumentObject *obj)
 Returns true if the given DocumentObject is DocumentObjectGroup but not GeoFeatureGroup.
 
static std::vector< App::DocumentObject * > getCSRelevantLinks (const App::DocumentObject *obj)
 
static bool areLinksValid (const App::DocumentObject *obj)
 
static bool isLinkValid (App::Property *link)
 

Public Attributes

PropertyLink Origin
 Origin linked to the group.
 

Protected Member Functions

virtual App::DocumentObjectExecReturnextensionExecute () override
 Checks integrity of the Origin.
 
virtual void onExtendedSetupObject () override
 Creates the corresponding Origin object.
 
virtual void onExtendedUnsetupObject () override
 Removes all planes and axis if they are still linked to the document.
 

Member Function Documentation

◆ getGroupOfObject()

static DocumentObject* App::OriginGroupExtension::getGroupOfObject ( const DocumentObject obj)
static

Returns the origin group which contains this object. In case this object is not part of any geoFeatureGroup 0 is returned.

Parameters
objthe object to search for