No documentation available.
More...
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 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 Boost.Python.instance: |
def | __new__ |
Detailed Description
Constructor & Destructor Documentation
def UnreadableComponentProxy.UnreadableComponentProxy.__init__ |
( |
|
args | ) |
|
Member Function Documentation
def UnreadableComponentProxy.UnreadableComponentProxy.__convert__ |
( |
|
args | ) |
|
def UnreadableComponentProxy.UnreadableComponentProxy.__dict__ |
( |
|
args | ) |
|
def UnreadableComponentProxy.UnreadableComponentProxy.__getinitargs__ |
( |
|
arg1 | ) |
|
def UnreadableComponentProxy.UnreadableComponentProxy.__getstate__ |
( |
|
args | ) |
|
def UnreadableComponentProxy.UnreadableComponentProxy.__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 UnreadableComponentProxy.UnreadableComponentProxy.__reduce__ |
( |
|
args | ) |
|
def UnreadableComponentProxy.UnreadableComponentProxy.__setstate__ |
( |
|
args | ) |
|
def UnreadableComponentProxy.UnreadableComponentProxy.__weakref__ |
( |
|
args | ) |
|
def UnreadableComponentProxy.UnreadableComponentProxy.Add |
( |
|
arg1, |
|
|
|
member_number |
|
) |
| |
- Returns
- Instance of type bool
Accept user input before launching the components edit dialog.
The default behavior is to call SetReferencePointForMemberUI().
- Note
- Additional signature: Add( (Component)arg1, (int)member_number) -> bool
Reimplemented from Component.Component.
def UnreadableComponentProxy.UnreadableComponentProxy.CanBeCopiedToOtherMembers |
( |
|
arg1 | ) |
|
- Returns
- Instance of type bool
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.
- Note
- Additional signature: CanBeCopiedToOtherMembers( (Component)arg1) -> bool
Reimplemented from Component.Component.
def UnreadableComponentProxy.UnreadableComponentProxy.Clone |
( |
|
arg1 | ) |
|
- Returns
- Instance of type object
Return a deep copy of the component. The default implementation
is suitable for most components.
Reimplemented from Component.Component.
def UnreadableComponentProxy.UnreadableComponentProxy.CreateDependentMaterial |
( |
|
arg1 | ) |
|
- Returns
- Instance of type bool
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.
- Note
- Additional signature: CreateDependentMaterial( (Component)arg1) -> bool
Reimplemented from Component.Component.
def UnreadableComponentProxy.UnreadableComponentProxy.CreateDependentMaterialOther |
( |
|
arg1, |
|
|
|
other_member_number |
|
) |
| |
- Returns
- Instance of type bool
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.
- Note
- Additional signature: CreateDependentMaterialOther( (Component)arg1, (int)other_member_number) -> bool
Reimplemented from Component.Component.
def UnreadableComponentProxy.UnreadableComponentProxy.CreateHoleMatch |
( |
|
arg1 | ) |
|
- Returns
- Instance of type bool
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.
- Note
- Additional signature: CreateHoleMatch( (Component)arg1) -> bool
Reimplemented from Component.Component.
def UnreadableComponentProxy.UnreadableComponentProxy.CreateHoleMatchOnMainMaterial |
( |
|
arg1 | ) |
|
- Returns
- Instance of type bool
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 UnreadableComponentProxy.UnreadableComponentProxy.CreateHoleMatchOnMainMaterialOther |
( |
|
arg1, |
|
|
|
other_member_number |
|
) |
| |
- Returns
- Instance of type bool
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 UnreadableComponentProxy.UnreadableComponentProxy.CreateHoleMatchOther |
( |
|
arg1, |
|
|
|
other_member_number |
|
) |
| |
- Returns
- Instance of type bool
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.
- Note
- Additional signature: CreateHoleMatchOther( (Component)arg1, (int)other_member_number) -> bool
Reimplemented from Component.Component.
def UnreadableComponentProxy.UnreadableComponentProxy.CreateHoleOnMainMaterial |
( |
|
arg1 | ) |
|
- Returns
- Instance of type None
Called as part of the default implementation for GraphicalCreateMaterial.
Reimplemented from Component.Component.
def UnreadableComponentProxy.UnreadableComponentProxy.CreateHoleOnMainMaterialOther |
( |
|
arg1, |
|
|
|
other_member_number |
|
) |
| |
- Returns
- Instance of type None
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 UnreadableComponentProxy.UnreadableComponentProxy.CreateMaterial |
( |
|
arg1 | ) |
|
- Returns
- Instance of type None
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.
- Note
- Additional signature: CreateMaterial( (Component)arg1) -> None
Reimplemented from Component.Component.
def UnreadableComponentProxy.UnreadableComponentProxy.CreateMaterialOther |
( |
|
arg1, |
|
|
|
other_member_number |
|
) |
| |
- Returns
- Instance of type None
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.
- Note
- Additional signature: CreateMaterialOther( (Component)arg1, (int)other_member_number) -> None
Reimplemented from Component.Component.
def UnreadableComponentProxy.UnreadableComponentProxy.CreateUI |
( |
|
args | ) |
|
def UnreadableComponentProxy.UnreadableComponentProxy.CreateViews |
( |
|
arg1 | ) |
|
def UnreadableComponentProxy.UnreadableComponentProxy.delui |
( |
|
args | ) |
|
def UnreadableComponentProxy.UnreadableComponentProxy.Description |
( |
|
args | ) |
|
def UnreadableComponentProxy.UnreadableComponentProxy.description |
( |
|
args | ) |
|
Text displayed in the model tree and during hover.
Components can customize the description by implementing Description.
Reimplemented from Component.Component.
def UnreadableComponentProxy.UnreadableComponentProxy.Design |
( |
|
arg1 | ) |
|
- Returns
- Instance of type bool
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.
- Note
- Additional signature: Design( (Component)arg1) -> bool
Reimplemented from Component.Component.
def UnreadableComponentProxy.UnreadableComponentProxy.Edit |
( |
|
args | ) |
|
def UnreadableComponentProxy.UnreadableComponentProxy.EditBeforeAddingToMember |
( |
|
self, |
|
|
|
member_number |
|
) |
| |
- Returns
- Instance of type bool
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.
- Note
- Additional signature: EditBeforeAddingToMember( (Component)self, (int)member_number) -> bool
Reimplemented from Component.Component.
def UnreadableComponentProxy.UnreadableComponentProxy.Finalize |
( |
|
args | ) |
|
def UnreadableComponentProxy.UnreadableComponentProxy.GetGraphical |
( |
|
arg1 | ) |
|
- Returns
- Instance of type bool
See the graphical property
Reimplemented from Component.Component.
def UnreadableComponentProxy.UnreadableComponentProxy.GetLayouts |
( |
|
arg1 | ) |
|
- Returns
- Instance of type list
Return layouts for display and modification in the model.
Reimplemented from Component.Component.
def UnreadableComponentProxy.UnreadableComponentProxy.GetMemberNumber |
( |
|
arg1 | ) |
|
- Returns
- Instance of type int
See the member_number property
Reimplemented from Component.Component.
def UnreadableComponentProxy.UnreadableComponentProxy.GetReferencePoint |
( |
|
arg1 | ) |
|
def UnreadableComponentProxy.UnreadableComponentProxy.GetState |
( |
|
args | ) |
|
def UnreadableComponentProxy.UnreadableComponentProxy.getui |
( |
|
args | ) |
|
def UnreadableComponentProxy.UnreadableComponentProxy.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 UnreadableComponentProxy.UnreadableComponentProxy.GraphicalCreateDependentMaterial |
( |
|
arg1 | ) |
|
- Returns
- Instance of type bool
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 UnreadableComponentProxy.UnreadableComponentProxy.GraphicalCreateDependentMaterialOther |
( |
|
arg1, |
|
|
|
other_member_number |
|
) |
| |
- Returns
- Instance of type bool
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 UnreadableComponentProxy.UnreadableComponentProxy.GraphicalCreateHoleMatch |
( |
|
arg1 | ) |
|
- Returns
- Instance of type bool
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 UnreadableComponentProxy.UnreadableComponentProxy.GraphicalCreateHoleMatchOther |
( |
|
arg1, |
|
|
|
other_member_number |
|
) |
| |
- Returns
- Instance of type bool
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 UnreadableComponentProxy.UnreadableComponentProxy.GraphicalCreateMaterial |
( |
|
arg1 | ) |
|
- Returns
- Instance of type None
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 UnreadableComponentProxy.UnreadableComponentProxy.GraphicalCreateMaterialOther |
( |
|
arg1, |
|
|
|
other_member_number |
|
) |
| |
- Returns
- Instance of type None
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 UnreadableComponentProxy.UnreadableComponentProxy.GraphicalProcessFinal |
( |
|
arg1 | ) |
|
- Returns
- Instance of type None
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 UnreadableComponentProxy.UnreadableComponentProxy.GraphicalProcessFinalOther |
( |
|
arg1, |
|
|
|
other_member_number |
|
) |
| |
- Returns
- Instance of type None
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 UnreadableComponentProxy.UnreadableComponentProxy.Hash |
( |
|
arg1 | ) |
|
def UnreadableComponentProxy.UnreadableComponentProxy.init_by_pickle_and_why |
( |
|
args | ) |
|
init_by_pickle_and_why(args)
def UnreadableComponentProxy.UnreadableComponentProxy.IsAllowedOnMember |
( |
|
arg1, |
|
|
|
member_number |
|
) |
| |
- Returns
- Instance of type bool
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.
- Note
- Additional signature: IsAllowedOnMember( (Component)arg1, (int)member_number) -> bool
Reimplemented from Component.Component.
def UnreadableComponentProxy.UnreadableComponentProxy.IsEraseable |
( |
|
arg1 | ) |
|
- Returns
- Instance of type bool
Returns a boolean which determines whether the component is removed
from the member on erase or turned graphical
- Note
- Additional signature: IsEraseable( (Component)arg1) -> bool
Reimplemented from Component.Component.
def UnreadableComponentProxy.UnreadableComponentProxy.IsValid |
( |
|
args | ) |
|
Indicate to the calling framework the current state of input
from the user.
Reimplemented from Component.Component.
def UnreadableComponentProxy.UnreadableComponentProxy.Load |
( |
|
args | ) |
|
def UnreadableComponentProxy.UnreadableComponentProxy.member_number |
( |
|
args | ) |
|
Number of the member the component is attached to or 0 if unattached.
Reimplemented from Component.Component.
def UnreadableComponentProxy.UnreadableComponentProxy.Modifies |
( |
|
arg1 | ) |
|
- Returns
- Instance of type list
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.
- Note
- Additional signature: Modifies( (Component)arg1) -> list
Reimplemented from Component.Component.
def UnreadableComponentProxy.UnreadableComponentProxy.MultiEdit |
( |
|
arg1, |
|
|
|
list_of_other_components_to_edit |
|
) |
| |
- Returns
- Instance of type bool
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.
- Note
- Additional signature: MultiEdit( (Component)arg1, (list)list_of_other_components_to_edit) -> bool
Reimplemented from Component.Component.
def UnreadableComponentProxy.UnreadableComponentProxy.OnBoltEvent |
( |
|
arg1, |
|
|
|
bolt_guid, |
|
|
|
bolt_event_id |
|
) |
| |
- Returns
- Instance of type None
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
- Note
- Additional signature: OnBoltEvent( (Component)arg1, (Uuid)bolt_guid, (BoltEvent)bolt_event_id) -> None
Reimplemented from Component.Component.
def UnreadableComponentProxy.UnreadableComponentProxy.OnErase |
( |
|
arg1 | ) |
|
- Returns
- Instance of type None
Called before a component is removed from the job
- Note
- Additional signature: OnErase( (Component)arg1) -> None
Reimplemented from Component.Component.
def UnreadableComponentProxy.UnreadableComponentProxy.OnGraphicalToggle |
( |
|
arg1 | ) |
|
- Returns
- Instance of type None
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.
- Note
- Additional signature: OnGraphicalToggle( (Component)arg1) -> None
Reimplemented from Component.Component.
def UnreadableComponentProxy.UnreadableComponentProxy.OnMaterialEvent |
( |
|
arg1, |
|
|
|
mtrl_guid, |
|
|
|
material_event_id |
|
) |
| |
- Returns
- Instance of type None
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
- Note
- Additional signature: OnMaterialEvent( (Component)arg1, (Uuid)mtrl_guid, (MaterialEvent)material_event_id) -> None
Reimplemented from Component.Component.
def UnreadableComponentProxy.UnreadableComponentProxy.OnMaterialNonGraphicalEvent |
( |
|
arg1, |
|
|
|
mtrl_guid, |
|
|
|
material_event_id |
|
) |
| |
- Returns
- Instance of type None
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.
- Note
- Additional signature: OnMaterialNonGraphicalEvent( (Component)arg1, (Uuid)mtrl_guid, (MaterialEvent)material_event_id) -> None
Reimplemented from Component.Component.
def UnreadableComponentProxy.UnreadableComponentProxy.OnMemberCopy |
( |
|
arg1 | ) |
|
- Returns
- Instance of type None
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.
- Note
- Additional signature: OnMemberCopy( (Component)arg1) -> None
Reimplemented from Component.Component.
def UnreadableComponentProxy.UnreadableComponentProxy.OnMemberMirrorCopy |
( |
|
arg1, |
|
|
|
original_member_to_mirrored_member_transform |
|
) |
| |
- Returns
- Instance of type None
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.
- Note
- Additional signature: OnMemberMirrorCopy( (Component)arg1, (Transform3D)original_member_to_mirrored_member_transform) -> None
Reimplemented from Component.Component.
def UnreadableComponentProxy.UnreadableComponentProxy.OnWeldEvent |
( |
|
arg1, |
|
|
|
weld_guid, |
|
|
|
weld_event_id |
|
) |
| |
- Returns
- Instance of type None
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
- Note
- Additional signature: OnWeldEvent( (Component)arg1, (Uuid)weld_guid, (WeldEvent)weld_event_id) -> None
Reimplemented from Component.Component.
def UnreadableComponentProxy.UnreadableComponentProxy.ProcessFinal |
( |
|
arg1 | ) |
|
- Returns
- Instance of type None
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.
- Note
- Additional signature: ProcessFinal( (Component)arg1) -> None
Reimplemented from Component.Component.
def UnreadableComponentProxy.UnreadableComponentProxy.ProcessFinalOther |
( |
|
arg1, |
|
|
|
other_member_number |
|
) |
| |
- Returns
- Instance of type None
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.
- Note
- Additional signature: ProcessFinalOther( (Component)arg1, (int)other_member_number) -> None
Reimplemented from Component.Component.
def UnreadableComponentProxy.UnreadableComponentProxy.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 UnreadableComponentProxy.UnreadableComponentProxy.RequiresProcess |
( |
|
args | ) |
|
def UnreadableComponentProxy.UnreadableComponentProxy.Reset |
( |
|
args | ) |
|
def UnreadableComponentProxy.UnreadableComponentProxy.Save |
( |
|
args | ) |
|
def UnreadableComponentProxy.UnreadableComponentProxy.SetGraphical |
( |
|
arg1, |
|
|
|
arg2 |
|
) |
| |
- Returns
- Instance of type None
See the graphical property
Reimplemented from Component.Component.
def UnreadableComponentProxy.UnreadableComponentProxy.SetReferencePoint |
( |
|
arg1, |
|
|
|
arg2 |
|
) |
| |
- Returns
- Instance of type None
See the ref_point property
Reimplemented from Component.Component.
def UnreadableComponentProxy.UnreadableComponentProxy.SetReferencePointForMemberUI |
( |
|
arg1, |
|
|
|
member_number |
|
) |
| |
- Returns
- Instance of type bool
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.
- Note
- Additional signature: SetReferencePointForMemberUI( (Component)arg1, (int)member_number) -> bool
Reimplemented from Component.Component.
def UnreadableComponentProxy.UnreadableComponentProxy.ui |
( |
|
args | ) |
|
def UnreadableComponentProxy.UnreadableComponentProxy.uuid |
( |
|
args | ) |
|
Unique id assigned to a component when it is added to a member.
Reimplemented from Component.Component.
Member Data Documentation
UnreadableComponentProxy.UnreadableComponentProxy.__getstate_manages_dict__ = True |
|
staticprivate |
int UnreadableComponentProxy.UnreadableComponentProxy.__instance_size__ = 40 |
|
staticprivate |
UnreadableComponentProxy.UnreadableComponentProxy.__safe_for_unpickling__ = True |
|
staticprivate |