VisualComponent Class |
Component model API for Demo3D visuals.
Implements an API for creating, managing, and querying components in the model.
The API allows a visual to be a member of more than one component at the same time. For example a conveyor "Catalog"
component may consist of a set of visuals (support stands, motor, skinned visuals, etc), but the motor part of the
conveyor may itself be a "CAD" component.
The type of component that a visual belongs to (eg "Catalog" component) is called the 'component-type'. For most of the
API calls, the caller can/must pass in the 'component-type' to use (or a list of component-types to choose from).
The storage and management of a component is handled by its 'component-model'. This manages the detail of how components
are stored in the model, and how a component behaves under certain conditions.
Each component-type, regardless of the model that manages it, can have component-type properties. The properties allow
user hooks for certain events (such as visuals being added/removed from a component) and control over how components of
that particular component-type should behave when being queried/manipulated.
Inheritance HierarchySystemObject
Demo3D.VisualsVisualComponent
Demo3D.VisualsVisualComponent
Namespace: Demo3D.Visuals
Assembly: Demo3D.Core (in Demo3D.Core.dll) Version: 10.0.0.6737
SyntaxC#
public static class VisualComponent
The VisualComponent type exposes the following members.
Methods| Name | Description | |
|---|---|---|
  | AddToComponent(Visual, String, Visual) |
Add a list of visuals to a component (or create a component).
|
| AddToComponent(Visual, String, IEnumerableVisual) |
Add a list of visuals to a component (or create a component).
|
| AddToComponent(Visual, Visual, VisualComponentComponentType, Boolean) |
Mark this visual as a member of the component. Component must be the root of an existing component, or null.
If deep is set, then this visual and all its descendants will be added to the component. If deep is not set
but this visual is already a member of a component, then it and all its child visuals within the current component,
will be moved to the new component.
|
| AddToComponent(Visual, Visual, String, Boolean) |
Mark this visual as a member of the component. Component must be the root of an existing component, or null.
If deep is set, then this visual and all its descendants will be added to the component. If deep is not set
but this visual is already a member of a component, then it and all its child visuals within the current component,
will be moved to the new component.
|
| BelongsToComponent |
Returns true if this visual belongs to a specific component.
|
| CommonComponentTypes |
Returns the component types common between this visual and a list of other visuals.
|
| Component(Visual, VisualComponentComponentType) |
Returns the component root for this visual, or null if it's not part of a component of the given component type.
|
| Component(Visual, VisualComponentSearchCriteria) |
Returns the component root for this visual.
|
| Component(Visual, String) |
Returns the component root for this visual.
|
| ComponentChildren(Visual, VisualComponentSearchCriteria) |
Returns all children of this component.
|
| ComponentChildren(Visual, String) |
Returns all children of this component.
|
| ComponentDescendants(Visual, VisualComponentSearchCriteria) |
Returns all descendants of this component.
|
| ComponentDescendants(Visual, String) |
Returns all descendants of this component.
|
| Components |
Returns all the components to which this visual belongs.
|
| ComponentTypes |
Returns an ordered list of all the component types to which this visual belongs.
|
| ComponentVisuals(Visual, VisualComponentComponentType) |
Returns all the visuals belonging to this component.
|
| ComponentVisuals(Visual, VisualComponentSearchCriteria) |
Returns all the visuals belonging to this component.
|
| ComponentVisuals(Visual, String) |
Returns all the visuals belonging to this component.
|
| CreateComponent |
Mark this visual as a component.
|
| FindComponentType(Visual, VisualComponentSearchCriteria) |
Returns a component type for this visual.
|
| FindComponentType(Visual, String) |
Returns a component type for this visual.
|
| IsComponentRoot(Visual, VisualComponentComponentType) |
Returns true if this visual is the root of its component.
|
| IsComponentRoot(Visual, VisualComponentSearchCriteria) |
Returns true if this visual is the root of its component.
|
| IsComponentRoot(Visual, String) |
Returns true if this visual is the root of its component.
|
| IsComponentType |
Returns true if this visual is a component member of componentType.
|
| Register |
Register a specific component model for a component type. The component model decides how a component should be delineated.
The default for components is the ComponentMembershipModel.
|
| RemoveFromComponent(String, Visual) |
Remove visuals from component.
|
| RemoveFromComponent(String, IEnumerableVisual) |
Remove visuals from component.
|
| RemoveFromComponent(Visual, VisualComponentComponentType) |
Remove this visual from component.
|
| RemoveFromComponent(Visual, String) |
Remove this visual from component.
|
| Unregister |
Unregister a component type.
|
Fields| Name | Description | |
|---|---|---|
 | CatalogComponent |
The default component-type given to all components pulled in from a catalog or the WebStore.
|
See Also