A primer class that has a decorator for hashing the object during the edit method. More...
Methods defined here: | |
def | __init__ |
Methods inherited from StateAccessor.StateAccessor: | |
def | __convert__ |
def | __getstate__ |
def | __setstate__ |
Data descriptors inherited from StateAccessor.StateAccessor: | |
def | __dict__ |
dictionary for instance variables (if defined) | |
def | __weakref__ |
list of weak references to the object (if defined) |
Data and other attributes inherited from StateAccessor.StateAccessor: | |
__getstate_manages_dict__ = True |
Methods inherited from componentedit.MemberEditMethods: | |
def | CreateUI |
def | Finalize |
def | IsValid |
def | Load |
def | RequiresProcess |
def | Reset |
def | Save |
def | delui |
def | getui |
Data descriptors inherited from componentedit.MemberEditMethods: | |
def | ui |
Data descriptors inherited from Component.Component: | |
def | description |
Text displayed in the model tree and during hover. | |
def | graphical |
True iff the component is graphical. | |
def | member_number |
Number of the member the component is attached to or 0 if unattached. | |
def | ref_point |
Reference point in member coordinates. | |
def | uuid |
Unique id assigned to a component when it is added to a member. |
Data and other attributes inherited from Component.Component: | |
int | __instance_size__ = 40 |
__safe_for_unpickling__ = True |
Data and other attributes inherited from Boost.Python.instance: | |
def | __new__ |
Additional Inherited Members | |
Public Member Functions inherited from StateAccessor.StateAccessor | |
Public Member Functions inherited from componentedit.MemberEditMethods | |
Public Member Functions inherited from Component.Component | |
def | CreateUI |
def | __setstate__ |
A primer class that has a decorator for hashing the object during the edit method.
use:
class ComponentName(HashingComponent): ... def __init__(self, *args, **kwargs): ... HashingComponent.__init__(MemberEditUI) ... Note: MemberEditUI is a subclass of ComponentUIHelper needed to run MemberEditMethods.__init__(self, ComponentUIHelper) @HashingComponent._hashing_decorator def Edit(self): ... Edit should not provide a return value in this case. the decorator will take care of that. Note: The subclass must define _version and _arguments as per StateAccessor
HashingComponent
StateAccessor.StateAccessor
componentedit.MemberEditMethods
Component.Component
Boost.Python.instance
builtin.object
def HashingComponent.HashingComponent.__init__ | ( | args | ) |
__init__(args)
Reimplemented from Component.Component.
def HashingComponent.HashingComponent.__convert__ | ( | args | ) |
__convert__(args)
Reimplemented from StateAccessor.StateAccessor.
def HashingComponent.HashingComponent.__dict__ | ( | args | ) |
dictionary for instance variables (if defined)
Reimplemented from Component.Component.
def HashingComponent.HashingComponent.__getinitargs__ | ( | arg1 | ) |
Reimplemented from Component.Component.
def HashingComponent.HashingComponent.__getstate__ | ( | args | ) |
__getstate__(args)
Reimplemented from Component.Component.
def HashingComponent.HashingComponent.__new__ | ( | args | ) |
T.__new__(S, ...) -> a new object with type S, a subtype of T
__new__ = <built-in method __new__ of Boost.Python.class object>
Reimplemented from Component.Component.
def HashingComponent.HashingComponent.__reduce__ | ( | args | ) |
__reduce__ = <unnamed Boost.Python function>(args)
Reimplemented from Component.Component.
def HashingComponent.HashingComponent.__setstate__ | ( | args | ) |
__setstate__(args)
Reimplemented from StateAccessor.StateAccessor.
def HashingComponent.HashingComponent.__weakref__ | ( | args | ) |
list of weak references to the object (if defined)
Reimplemented from Component.Component.
def HashingComponent.HashingComponent.Add | ( | arg1, | |
member_number | |||
) |
Accept user input before launching the components edit dialog. The default behavior is to call SetReferencePointForMemberUI().
Reimplemented from Component.Component.
def HashingComponent.HashingComponent.CanBeCopiedToOtherMembers | ( | arg1 | ) |
Return True iff this component can be copied to other members. By default any component can be copied to any member but components can override this method if that behavior is inappropriate.
Reimplemented from Component.Component.
def HashingComponent.HashingComponent.Clone | ( | arg1 | ) |
Return a deep copy of the component. The default implementation is suitable for most components.
Reimplemented from Component.Component.
def HashingComponent.HashingComponent.CreateDependentMaterial | ( | arg1 | ) |
Called when the component is *not* graphical during the third material creation phase of process (also referred to as the 'bolt match phase'). This method should bolt match any holes on the component's member that were created during the hole match. See the Process section in the class documentation for more details.
Reimplemented from Component.Component.
def HashingComponent.HashingComponent.CreateDependentMaterialOther | ( | arg1, | |
other_member_number | |||
) |
Called when the component is *not* graphical during the third material creation phase of process (also referred to as the 'bolt match phase'). This method should bolt match any holes on the specified member that were created during the hole match phase. See the Process section in the class documentation for more details.
Reimplemented from Component.Component.
def HashingComponent.HashingComponent.CreateHoleMatch | ( | arg1 | ) |
Called when the component is *not* graphical during the second material creation phase of process. This method should create holes on the component's member by matching them to holes created on a different member. See the Process section in the class documentation for more details.
Reimplemented from Component.Component.
def HashingComponent.HashingComponent.CreateHoleMatchOnMainMaterial | ( | arg1 | ) |
Called from the default implementation of GraphicalCreateHoleMatch. Graphical components should still create holes on main material. See the Graphical and Process sections in the class documentation for more details.
Reimplemented from Component.Component.
def HashingComponent.HashingComponent.CreateHoleMatchOnMainMaterialOther | ( | arg1, | |
other_member_number | |||
) |
Called from the default implementation of GraphicalCreateHoleMatchOther. Graphical components should still create holes on main material. See the Graphical and Process sections in the class documentation for more details.
Reimplemented from Component.Component.
def HashingComponent.HashingComponent.CreateHoleMatchOther | ( | arg1, | |
other_member_number | |||
) |
Called when the component is *not* graphical during the second material creation phase of process. This method should create holes on the specified member by matching them to holes created on a different member. See the Process section in the class documentation for more details.
Reimplemented from Component.Component.
def HashingComponent.HashingComponent.CreateHoleOnMainMaterial | ( | arg1 | ) |
Called as part of the default implementation for GraphicalCreateMaterial.
Reimplemented from Component.Component.
def HashingComponent.HashingComponent.CreateHoleOnMainMaterialOther | ( | arg1, | |
other_member_number | |||
) |
Called from the default implementation of GraphicalCreateMaterialOther when the component is graphical during the first material creation phase of process. Components should still create holes on material they did not create even when the component is graphical.
Reimplemented from Component.Component.
def HashingComponent.HashingComponent.CreateMaterial | ( | arg1 | ) |
Called when the component is *not* graphical during the first material creation phase of process (also referred to as the 'independent material phase'). This method should create all the material, bolts, holes, and welds on the component's member that don't require other materials to already exist in the job. See the Process section in the class documentation for more details.
Reimplemented from Component.Component.
def HashingComponent.HashingComponent.CreateMaterialOther | ( | arg1, | |
other_member_number | |||
) |
Called when the component is *not* graphical in the first material creation phase of process (also referred to as the 'independent material phase'). This method should create all the material, bolts, holes, and welds on the specified member that don't require other materials to already exist in the job. See the Process section in the class documentation for more details.
Reimplemented from Component.Component.
def HashingComponent.HashingComponent.CreateUI | ( | args | ) |
CreateUI(args)
Reimplemented from componentedit.MemberEditMethods.
def HashingComponent.HashingComponent.CreateViews | ( | arg1 | ) |
Reimplemented from Component.Component.
def HashingComponent.HashingComponent.delui | ( | args | ) |
delui(args)
Reimplemented from componentedit.MemberEditMethods.
def HashingComponent.HashingComponent.Description | ( | arg1 | ) |
Return the text used in the model tree and during hover.
Reimplemented from Component.Component.
def HashingComponent.HashingComponent.description | ( | args | ) |
Text displayed in the model tree and during hover.
Components can customize the description by implementing Description.
Reimplemented from Component.Component.
def HashingComponent.HashingComponent.Design | ( | arg1 | ) |
Called during process when the component's member is marked for process. Design will be called before any of the material creation methods. The component should know all the material that will be created upon completion. Beware, it is possible for the component to create material on other members without process explicitly calling Design first. See the Process section in the class documentation for more details.
Reimplemented from Component.Component.
def HashingComponent.HashingComponent.Edit | ( | arg1 | ) |
Prompt the user with a stand alone single edit screen. Return Trueto indicate the user closed the screen by choosing the 'OK' button.
Reimplemented from Component.Component.
def HashingComponent.HashingComponent.EditBeforeAddingToMember | ( | self, | |
member_number | |||
) |
The edit screen before a component is actually added to the member during the component add tool. The default implementation is to call the normal Edit method.
Reimplemented from Component.Component.
def HashingComponent.HashingComponent.Finalize | ( | args | ) |
Finalize(args)
Reimplemented from Component.Component.
def HashingComponent.HashingComponent.GetGraphical | ( | arg1 | ) |
See the graphical property
Reimplemented from Component.Component.
def HashingComponent.HashingComponent.GetLayouts | ( | arg1 | ) |
Return layouts for display and modification in the model.
Reimplemented from Component.Component.
def HashingComponent.HashingComponent.GetMemberNumber | ( | arg1 | ) |
See the member_number property
Reimplemented from Component.Component.
def HashingComponent.HashingComponent.GetReferencePoint | ( | arg1 | ) |
See the ref_point property
Reimplemented from Component.Component.
def HashingComponent.HashingComponent.GetState | ( | arg1 | ) |
A method that must be provided by the implementer of the component. This method should always return a different instance of the same object type. That object must provide a __eq__ method which returns True when compared with an object that has the same state as far as process is concerned.
Reimplemented from Component.Component.
def HashingComponent.HashingComponent.getui | ( | args | ) |
getui(args)
Reimplemented from componentedit.MemberEditMethods.
def HashingComponent.HashingComponent.graphical | ( | args | ) |
True iff the component is graphical.
By default a graphical component will not recreate new solids during process.
Reimplemented from Component.Component.
def HashingComponent.HashingComponent.GraphicalCreateDependentMaterial | ( | arg1 | ) |
Called when the component is graphical during the third material creation phase of process (also referred to as the 'bolt match phase'). This method should bolt match any holes on the component's member that were created during the hole match phase when the component is graphical. The defaul implementation does nothing which should be suitable for most components. See the Graphical and Process sections in the class documentation for more details.
Reimplemented from Component.Component.
def HashingComponent.HashingComponent.GraphicalCreateDependentMaterialOther | ( | arg1, | |
other_member_number | |||
) |
Called when the component is graphical during the third material creation phase of process (also referred to as the 'bolt match phase'). The default implementation does nothing and is likely the correct behavior for most components. See the Graphical and Process sections in the class documentation for more details.
Reimplemented from Component.Component.
def HashingComponent.HashingComponent.GraphicalCreateHoleMatch | ( | arg1 | ) |
Called when the component is graphical during the second material creation phase of process. This method should create holes on the component's member by matching them to holes created on a different member. The default implementation calls CreateHoleMatchOnMainMaterial because graphical components should still create holes on main material. See the Graphical and Process sections in the class documentation for more details.
Reimplemented from Component.Component.
def HashingComponent.HashingComponent.GraphicalCreateHoleMatchOther | ( | arg1, | |
other_member_number | |||
) |
Called when the component is graphical during the second material creation phase of process. This method should create holes on the specified member by matching them to holes created on a different member. The default implementation calls CreateHoleMatchOnMainMaterialOther because graphical components should still create holes on main material. See the Graphical and Process sections in the class documentation for more details.
Reimplemented from Component.Component.
def HashingComponent.HashingComponent.GraphicalCreateMaterial | ( | arg1 | ) |
Called when the component is graphical during the first material creation phase of process (also referred to as the 'independent material phase'). This method should create all the material, bolts, holes, and welds on the component's member when the component is graphical. The default implementation calls CreateHoleOnMainMaterial because graphical components should still create holes on main material. See the Graphical and Process sections in the class documentation for more details.
Reimplemented from Component.Component.
def HashingComponent.HashingComponent.GraphicalCreateMaterialOther | ( | arg1, | |
other_member_number | |||
) |
Called when when the component is graphical during the first material creation phase of process. The default implementation simply calls CreateHoleOnMainMaterialOther. See the Graphical and Process sections in the class documentation for more details.
Reimplemented from Component.Component.
def HashingComponent.HashingComponent.GraphicalProcessFinal | ( | arg1 | ) |
Called when the component is graphical as the last phase of process. The default implementation does nothing which should be suitable for most components. See the Graphical and Process sections in the class documentation for more details.
Reimplemented from Component.Component.
def HashingComponent.HashingComponent.GraphicalProcessFinalOther | ( | arg1, | |
other_member_number | |||
) |
Called when the component is graphical as the last phase of process. The default implementation does nothing which should be suitable for most components. See the Graphical and Process sections in the class documentation for more details.
Reimplemented from Component.Component.
def HashingComponent.HashingComponent.Hash | ( | arg1 | ) |
Reimplemented from Component.Component.
def HashingComponent.HashingComponent.IsAllowedOnMember | ( | arg1, | |
member_number | |||
) |
Return True iff this component is allowed on the specified member. By default any component is allowed on any member but if a component should only be added to beams this method should be overridden to return True iff the specified member is a beam.
Reimplemented from Component.Component.
def HashingComponent.HashingComponent.IsEraseable | ( | arg1 | ) |
Returns a boolean which determines whether the component is removed from the member on erase or turned graphical
Reimplemented from Component.Component.
def HashingComponent.HashingComponent.IsValid | ( | args | ) |
Indicate to the calling framework the current state of input from the user.
Reimplemented from Component.Component.
def HashingComponent.HashingComponent.Load | ( | args | ) |
Load(args)
Reimplemented from Component.Component.
def HashingComponent.HashingComponent.member_number | ( | args | ) |
Number of the member the component is attached to or 0 if unattached.
Reimplemented from Component.Component.
def HashingComponent.HashingComponent.Modifies | ( | arg1 | ) |
Return a list of member numbers that this custom member adds materials, holes, bolts, or welds to. This list has a number of important uses including ensuring members are processed, graphical flags are propagated, and locks are handled correctly. This method is called regularly, and as such, should return quickly. Components that take a linear amount of time to compute this list should consider caching the return value as part of the stored state of the component and validating this cache on subsequent calls.
Reimplemented from Component.Component.
def HashingComponent.HashingComponent.MultiEdit | ( | arg1, | |
list_of_other_components_to_edit | |||
) |
Prompt the user with a stand alone multi edit screen. Return True to indicate the user closed the screen by choosing the 'OK' button. Components do not support multi edit by default.
Reimplemented from Component.Component.
def HashingComponent.HashingComponent.OnBoltEvent | ( | arg1, | |
bolt_guid, | |||
bolt_event_id | |||
) |
Called when one of the bolts that the component created generates an Event.BoltEvent. This method plays an important part in managing the graphical state of a component. The default implementation is AllOrNoneGraphical.SetPluginSystemGenereated(self, False) It should not perform any user interaction
Reimplemented from Component.Component.
def HashingComponent.HashingComponent.OnErase | ( | arg1 | ) |
Called before a component is removed from the job
Reimplemented from Component.Component.
def HashingComponent.HashingComponent.OnGraphicalToggle | ( | arg1 | ) |
Propogate the component's graphical state change to all the objects that the component created. The default implementation is AllOrNoneGraphical.SetPluginSystemGenerated(self, not self.graphical) The method must normally be explicilty invoked from python for it to fire. It should not perform any user interaction.
Reimplemented from Component.Component.
def HashingComponent.HashingComponent.OnMaterialEvent | ( | arg1, | |
mtrl_guid, | |||
material_event_id | |||
) |
Called when one of the materials that the component created generates an Event.MaterialEvent. This method plays an important part in managing the graphical state of a component. The default implementation is AllOrNoneGraphical.SetPluginSystemGenereated(self, False) It should not perform any user interaction
Reimplemented from Component.Component.
def HashingComponent.HashingComponent.OnMaterialNonGraphicalEvent | ( | arg1, | |
mtrl_guid, | |||
material_event_id | |||
) |
Called when one of the component created materials is changed in a way that does not typically result in user material, e.g a user changes the color. The default implementation does nothing.
Reimplemented from Component.Component.
def HashingComponent.HashingComponent.OnMemberCopy | ( | arg1 | ) |
Called after a component is copied to a new member. This method should update any state that might change based on being copied to a new member. It should not perform any user interaction.
Reimplemented from Component.Component.
def HashingComponent.HashingComponent.OnMemberMirrorCopy | ( | arg1, | |
original_member_to_mirrored_member_transform | |||
) |
Called when a member is copied and mirrored. This method should mirror any other atrributes appropriately given the specified transform. The default implementation mirrors ref_point attribute. It should not perform any user interaction.
Reimplemented from Component.Component.
def HashingComponent.HashingComponent.OnWeldEvent | ( | arg1, | |
weld_guid, | |||
weld_event_id | |||
) |
Called when one of the welds that the component created generates an Event.WeldEvent. This method plays an important part in managing the graphical state of a component. The default implementation is AllOrNoneGraphical.SetPluginSystemGenereated(self, False) It should not perform any user interaction
Reimplemented from Component.Component.
def HashingComponent.HashingComponent.ProcessFinal | ( | arg1 | ) |
Called when the component is *not* graphical as the last phase of process. Components could use this method to erase temporary material used for fitting, resuing material guids, or any other clean up that needs to be done but wasn't in the other phases of process. See the Process section in the class documentation for more details.
Reimplemented from Component.Component.
def HashingComponent.HashingComponent.ProcessFinalOther | ( | arg1, | |
other_member_number | |||
) |
Called when the component is *not* graphical as the last phase of process. Components could use this method to erase temporary material used for fitting, resuing material guids, or any other clean up that needs to be done but wasn't in the other phases of process. See the Process section in the class documentation for more details.
Reimplemented from Component.Component.
def HashingComponent.HashingComponent.ref_point | ( | args | ) |
Reference point in member coordinates.
When the component is hovered in modeling this point will be visualized with an indicator.
Reimplemented from Component.Component.
def HashingComponent.HashingComponent.RequiresProcess | ( | args | ) |
RequiresProcess(args)
Reimplemented from componentedit.MemberEditMethods.
def HashingComponent.HashingComponent.Reset | ( | args | ) |
Reset(args)
Reimplemented from Component.Component.
def HashingComponent.HashingComponent.Save | ( | args | ) |
Save(args)
Reimplemented from Component.Component.
def HashingComponent.HashingComponent.SetGraphical | ( | arg1, | |
arg2 | |||
) |
See the graphical property
Reimplemented from Component.Component.
def HashingComponent.HashingComponent.SetReferencePoint | ( | arg1, | |
arg2 | |||
) |
See the ref_point property
Reimplemented from Component.Component.
def HashingComponent.HashingComponent.SetReferencePointForMemberUI | ( | arg1, | |
member_number | |||
) |
Set the ref_point given the specified member and return True iff the operation should not be cancelled after any potential user input. This method is called when copying or moving a component and is also called in the default implementation of Add(). The default behavior is to prompt the user for an arbitrary point in global coordinates and then convert that point to a point in the specified member's coordinate system.
Reimplemented from Component.Component.
def HashingComponent.HashingComponent.ui | ( | args | ) |
Reimplemented from componentedit.MemberEditMethods.
def HashingComponent.HashingComponent.uuid | ( | args | ) |
Unique id assigned to a component when it is added to a member.
Reimplemented from Component.Component.
|
staticprivate |
|
staticprivate |
|
staticprivate |