Class SceneInterface
Inherited Members
Namespace: UnityEngine.Pixyz.Scene
Assembly: Unity.Pixyz.SDKPlus.Runtime.dll
Syntax
public class SceneInterface : Interface
Methods
Name | Description |
---|---|
AddAnimation(uint) | Add an animation in Animation library |
AddComponent(uint, ComponentType) | Add a component to an occurrence |
AddComponents(OccurrenceList, ComponentType) | Add a components to each occurrence in the array |
AddFilterToLibrary(string, string) | Add a filter to the filters library |
AddKeyframe(uint, ulong, double) | Adds a keyframe in the curve |
AddKeyframeFromCurrentPosition(uint, ulong) | Adds keyframes in a given AnimChannel based on current position |
AddLOD(uint, uint, double) | Add a LOD to a LODComponent |
AddLightComponent(uint, LightType, Color, double, double) | Add a light component to an occurrence |
AddMetadata(uint, string, string) | Add a new metadata property to a metadata component |
AddMetadataBlock(uint, StringList, StringList) | Add a new metadata property to a metadata component |
AddVariant(string) | Create a new variant |
AlignPivotPointToWorld(OccurrenceList, bool) | Re-orient the Pivot Point straight to world origin (the grid) |
AnimatesThisOccurrence(uint, uint) | Does this Animation animates this Occurrence - or one of its parents (thus animating it indirectly) ? |
ApplyTransformation(uint, Matrix4) | apply a transformation to the local matrix of an occurrence |
BakeAnimation(uint, uint, uint, ulong) | Baking soda |
CleanInstances(bool, bool, uint) | Clean prototypes and instances (lonely instances, overriding their prototypes hierarchies...). |
CleanUnusedImages() | Remove unused images from texture library |
CleanUnusedMaterials(bool) | Remove unused materials from material library |
ClearSelection() | Clear the current selection |
Compress(uint) | Compress a sub-tree by removing occurrence containing only one Child or empty, and by removing useless instances (see removeUselessInstances) |
ComputeSubTreeChecksum(uint) | Compute the checksum of a sub-tree |
ConfigureFunctionLogger(string, bool, bool, bool) | |
ConfigureOoC(uint, string, string) | Set and configure an Out of Core component implementation |
ConvertMaterialsToColor(MaterialList) | Convert all materials to materials with a color pattern, trying to keep the visual aspect as similar as possible |
ConvertMaterialsToPBR(MaterialList) | Convert all materials to materials with a PBR pattern, trying to keep the visual aspect as similar as possible |
ConvertPMIToOccurrences(OccurrenceList, bool) | Convert each PMI component into a set of occurrences with mesh geometries |
ConvertToOldSchoolVisibility(uint) | Modify the visible properties of the sub-tree to look like old school visibility (only hidden/inherited) |
CreateAlternativeTree(string, uint) | Create a new alternative tree |
CreateAnimation(string) | Creates an animation, need to use addAnimation when animation is filled |
CreateCone(double, double, int, bool) | Create a new cone |
CreateCube(double, double, double, int, bool) | Create a new cube |
CreateCylinder(double, double, int, bool) | Create a new cylinder |
CreateHierarchicalClusters(uint, int, double) | Reorganize a sub tree with hierarchical clustering |
CreateImmersion(double, int, int) | Create a new bagel klein |
CreateLight(string, LightType, Color, double, double, uint) | Create an occurrence with a light component |
CreateMetadatasFromDefinitions(OccurrenceList, MetadataDefinitionList) | Create Metadata components from definitions |
CreateOBBMesh(uint) | |
CreateOccurrence(string, uint) | Create a new occurrence |
CreateOccurrenceFromSelection(string, OccurrenceList, uint, bool) | Create a new occurrence and add the given occurrences as children |
CreateOccurrenceFromText(string, string, int, ColorAlpha?, double) | Creates an occurrence from string |
CreateOccurrences(string, OccurrenceList) | Create one new occurrence under each given parent |
CreatePartsFromMeshes(OccurrenceList, MeshList) | Create a set of Parts given meshes and occurrences |
CreatePlane(double, double, int, int, bool) | Create a new plane |
CreateRayProber() | Creates a ray prober |
CreateSceneFromMeshes(MeshList, Matrix4List, bool) | Create a scene tree with a list of meshes, all meshes becomes part occurrences with the same root. The same mesh Id can be used several times to handle create instances (prototypes) |
CreateSkeletonMesh(uint) | Create a skeleton mesh from a joint component tree |
CreateSphere(double, int, int, bool) | Create a new sphere |
CreateSphereProber() | Creates a sphere prober |
CreateSubTree(PackedTree, uint, bool) | Create a complete scene tree |
CreateSymmetry(OccurrenceList, AxisPlane) | Create symmetries from selection |
CreateTorus(double, double, int, int) | Create a new torus |
DebugAnimation(uint) | jaaj |
DebugAnimations() | h4xx_h3re |
DecimateAnimChannelBySegment(uint, double) | Decimates by segment a given AnimChannel |
DeleteAnimation(uint) | Deletes an animation |
DeleteComponentByType(ComponentType, uint, bool) | Delete component from type |
DeleteComponentsByType(ComponentType, uint) | Delete all components on subtree from type |
DeleteEmptyAnimation() | Delete all animation that contain 0 keyframes |
DeleteEmptyOccurrences(uint) | Delete all empty assemblies |
DeleteOccurrences(OccurrenceList) | Delete a liste of occurrences |
DeleteSelection() | Delete all selected occurrences, and/or sub-occurrence elements |
DisplayAllKeyframesFromAnimChannel(uint) | Displays info on the selected AnimChannel |
DisplayAllKeyframesFromAnimation(uint) | Displays info on the selected animation |
DisplayValueFromAnimChannelAtTime(uint, ulong, bool) | Displays the value |
DuplicateVariant(uint, string) | Create a new variant which is a copy of an existing variant |
EvaluateExpression(string) | Evaluate the given filter expression |
EvaluateExpressionOnOccurrences(OccurrenceList, string) | evaluate the given filter expression on all occurrences under the given occurrence and returns the result |
EvaluateExpressionOnSubTree(string, uint) | evaluate the given filter expression on all occurrences under the given occurrence and returns the result |
ExplodeSelection() | For each occurrence, create a new occurrence with the selected sub-occurrence elements and remove them from the original occurrence |
ExportFilterLibrary(string) | Export filters from a given file |
FindByActiveMaterial(uint, OccurrenceList) | Find all part occurrence with a given material as active material (i.e. as seen in the rendering) |
FindByMetadata(string, Regex, OccurrenceList) | Returns all occurrences which a metadata property value matches the given regular expression (ECMAScript) |
FindByMetadataValue(Regex, OccurrenceList) | Returns all occurrences with a metadata value matching the given regular expression (ECMAScript) |
FindByProperty(string, Regex, OccurrenceList) | Returns all occurrences which a property value matches the given regular expression (ECMAScript) |
FindFilterByName(string) | Returns the first filter in the filter library with the given name |
FindPartOccurrencesInAABB(AABB) | find part occurrences in the scene in a given axis aligned bounding box |
GenerateOctaViews(double, int, int, bool) | |
GenerateOctree(uint, int, double) | Generate a loose octree from the given sub-tree |
GetAABB(OccurrenceList) | Returns the axis aligned bounding box of a list of scene paths |
GetActiveMaterial(uint) | Get the active material on occurrence |
GetActivePropertyValue(uint, string, bool) | Get the value of a property on the first parent that own it |
GetActivePropertyValues(OccurrenceList, string, bool) | Get the value of a property on the first parent that own it for each given occurrence |
GetAlternativeTreeRoot(uint) | Returns the root occurrence associated with the given AlternativeTree |
GetAncestors(uint) | Returns the list of ancestors for one occurrence |
GetAnimChannelIfExists(uint, uint) | Returns the main AnimChannel of an Occurrence according to a given Animation |
GetAnimChannelInfo(uint) | get an animation channel informations |
GetAnimChannelOccurrence(uint) | Returns the Occurrence related to a given AnimChannel |
GetAnimationComponentPropertyBinderLists(uint) | packs all animation-related info in an object |
GetAnimationInfo(uint) | packs all animation-related info in an object |
GetAnimationPropertyBinderLists(uint) | packs all animation-related info in an object |
GetAnnotationDefinition(uint) | get definition of given annotation |
GetAnnotationGroups(uint) | Returns the list of the AnnotationGroup from a PMIComponent |
GetAnnotations(uint) | Returns the list of the Annotation from a AnnotationGroup |
GetBRepInfos() | |
GetChildren(uint) | Get the children of an occurrence |
GetComponent(uint, ComponentType, bool) | Returns a component on an occurrence |
GetComponentByOccurrence(OccurrenceList, ComponentType, bool) | Returns one component of the specified type by occurrence if it exists |
GetComponentOccurrence(uint) | Get the occurrence that own a component |
GetComponentType(uint) | Get the type of a component |
GetCurrentVariantRoot() | Get the current active root. Returns active variant's root if one or global root. |
GetDebugRoot() | Get the debug viewer root occurrence of the product structure |
GetDuplicatedParts(uint, double, double, double, double) | Get duplicated parts |
GetFilterExpression(uint) | Returns the filter expression (string) from a filter id stored in the library |
GetFilterFromLibrary(uint) | Retrieve a filter from the library with its identifier |
GetFilteredOccurrences(string, uint) | Recursively get all the occurrences validating the given filter expression |
GetGlobalMatrix(uint) | Returns the global matrix on an occurrence |
GetGlobalVisibility(uint) | Returns the global visibility of a given occurrence |
GetJointDefinition(uint) | Get joint definition from id |
GetJointDefinitions(JointList) | Get joint definition from id |
GetKeyframeParentAnimChannel(uint) | Returns the parent AnimChannel of a given Keyframe |
GetKeyframes(uint) | Returns a list of all keyframes of a simple animChannel |
GetLODComponentOfLOD(uint) | Retrieve the LOD component that use a given LOD |
GetLODComponents() | Get all LODComponent of the scene |
GetLODs(uint) | Get all LODs of a LODComponent |
GetLastError() | |
GetLocalMatrix(uint) | Returns the local matrix on an occurrence |
GetMBB(OccurrenceList) | Returns the Minimum Bounding Box of a list of scene paths |
GetMainChannel(uint) | Returns the main AnimChannel of a given AnimChannel |
GetMaterialsFromSubtree(uint) | |
GetMetadata(uint, string) | Get a metadata property value from a metadata component |
GetMetadatasDefinitions(MetadataList) | Returns definition of Metadata components |
GetMultipleOccurrenceUserData(uint, OccurrenceList) | Batch version of getOccurrenceUserData |
GetOBB(OccurrenceList) | Returns the Oriented Bounding Box of a list of scene paths (works only on meshes, fast method, not the Minimum Volume Box) |
GetOccurrenceActiveMaterial(uint) | Returns the active material on a given occurrence |
GetOccurrenceAncestors(uint) | |
GetOccurrenceAnnotationDefinitions(uint) | get all annotations definition of given occurrence |
GetOccurrenceJoint(uint) | Returns the Joint assigned to an occurrence if any |
GetOccurrenceLOD(uint) | Retrieve the LOD that references a given occurrence (if any) |
GetOccurrenceName(uint) | Returns the name of an occurrence |
GetOccurrenceUserData(uint, uint) | Set or replace a userdata stored on an occurrence |
GetOccurrencesAncestors(OccurrenceList) | |
GetOccurrencesWithComponent(ComponentType, uint) | Recursively get all the occurrences containing a component of the specified type |
GetOoCConfiguration(uint) | Get the current configuration of an Out of Core component |
GetParent(uint) | Get the parent of an occurrence |
GetParentChannel(uint) | Returns (if exists) the parent AnimChannel of a given AnimChannel |
GetPartActiveShape(uint) | Returns the active shape of a part |
GetPartMesh(uint) | Return the mesh of the TesselatedShape |
GetPartModel(uint) | Return the model of the BRepShape |
GetPartOccurrences(uint) | Recursively get all the occurrences containing a part component |
GetPartShapeType(uint) | Get the part's shape type |
GetPartsMeshes(PartList) | Return the meshes of the TesselatedShape for each given parts if any |
GetPartsModels(PartList) | Return the models of the BRepShape for each given parts if any |
GetPartsTransforms(PartList) | Returns the transform matrix of each given parts |
GetPartsTransformsIndexed(PartList) | Returns the transform matrix of each given parts (indexed mode) |
GetPolygonCount(OccurrenceList, bool, bool, bool) | Returns the number of polygon in the parts meshes |
GetProductViewDefinition(uint) | get productview definition |
GetProductViewDefinitions() | get all productviews definitions |
GetPrototype(uint) | Returns the prototype of an occurrence |
GetReferencers(uint) | Returns all the occurrences prototyping the given occurrence |
GetRoot() | Get the root occurrence of the product structure |
GetSelectedOccurrences(bool) | Returns all the selected occurrences |
GetSubChannel(uint, string) | Returns the subchannel of a given name from an AnimChannel |
GetSubChannels(uint) | Returns all the sub channel of an AnimChannel |
GetSubTree(uint, VisibilityMode, int) | Returns a packed version of the whole scene tree |
GetSubTreeStats(uint) | Returns some stats of a sub tree |
GetSubpartMaterial(uint, uint) | Get a subpart material assignment according to overrides on the scene tree with SubpartMaterial components |
GetTessellationInfos(uint) | |
GetUnstitchedFacesOccurrences(uint) | Find all the occurrences with unstitched faces |
GetVariantComponentsDefinitions(VariantComponentList) | Returns the definitions of multiple variant components |
GetVariantTree(uint) | Get the alternative tree used by this variant |
GetVertexCount(OccurrenceList, bool, bool, bool, bool) | Returns the number of vertices in the parts meshes |
GetViewpointsFromCavities(double, double) | Returns viewpoints from model cavities |
HasComponent(uint, ComponentType, bool) | Returns True if the given occurrence has the given component type |
HasMultipleOccurrenceUserData(uint, OccurrenceList) | Batch version of hasOccurrenceUserData |
HasOccurrenceUserData(uint, uint) | Set or replace a userdata stored on an occurrence |
Hide(uint) | Hide the given occurrence |
IdentifyInstances(int) | Identify parts with more than one occurrence on the scene |
ImportFilterLibrary(string) | Import filters from a given file |
InverseVisibility(uint) | Inverse the visibility of the given occurrence |
InvertOrientationSelection() | Invert the orientation of each selected item (occurrences and/or sub-occurrence elements |
InvertSelection() | Replace the selection by all unselected part occurrences |
IsAncestorOf(uint, uint) | Test if the occurrences are ancestors to one another. |
Isolate(OccurrenceList) | Enter isolate mode by isolating a subset of the scene for process, export, viewer, ... |
LinkPropertyToAnimation(uint, uint, string) | Creates a Binder in an Animation stack to animate an entity's property |
ListActiveShapeMaterials(uint) | list all the materials used in the part shape |
ListAlternativeTrees() | Returns all the available alternative trees |
ListAnimations() | List all Animations from the scene |
ListComponent(ComponentType) | List all components on a type on the whole tree |
ListComponents(uint, bool) | List all components on an occurrence |
ListFilterLibrary() | Returns all the filter stored in the filter library |
ListMainChannels(uint) | List all main AnimChannel from a given Animation |
ListMainChannelsFromOccurrence(uint) | List all main AnimChannel from a given Occurrence |
ListOoCImplementations() | |
ListSubpartMaterials(uint) | list all the materials used in the part shape or overrided with a SubpartMaterial component |
ListSubpartVariantMaterials(uint) | list all the materials variants in subpart |
ListVariants() | Returns all the available variants |
LoadOoC(uint) | Ask an Out of Core component to load its sub-scene |
MakeDefaultKeyframe(uint) | Creates keyframes with the default values of the channel at time 0 |
MakeInstanceUnique(OccurrenceList) | Singularize all instances on the sub-tree of an occurrence |
MergeByRegions(OccurrenceList, MergeByRegionsStrategy, MergeStrategy) | Merge all parts within the same area. |
MergeByTreeLevel(OccurrenceList, int, MergeHiddenPartsMode) | Merge all parts over maxLevel level |
MergeFinalLevel(OccurrenceList, MergeHiddenPartsMode, bool) | Merge final level (occurrences with only occurrence with part component as children) |
MergeImages(ImageList) | Merge all equivalent images (i.e. with same pixels) |
MergeMaterials(MaterialList, bool) | Merge all equivalent materials (i.e. with same appearance) |
MergeOpenShells(uint) | Merge open shells |
MergeParts(OccurrenceList, MergeHiddenPartsMode) | Merge a set of parts |
MergePartsByAssemblies(OccurrenceList, MergeHiddenPartsMode) | Merge all parts under each assembly together |
MergePartsByMaterials(OccurrenceList, bool, MergeHiddenPartsMode, bool) | Merge a set of parts by materials |
MergePartsByName(uint, MergeHiddenPartsMode) | Merge all parts by occurrences names |
MoveAnimation(uint, uint, uint, ulong) | Moving animation |
MoveOccurrences(OccurrenceList, uint, uint) | Move an occurrence, adjusting the transformation to keep objects at the same place in the world space |
MovePivotPointToOccurrenceCenter(OccurrenceList, bool) | Move the pivot point of each occurrence listed in the function input, to the center of its bounding box (and of its children if the parameter is True) |
MovePivotPointToOrigin(uint, bool) | Move the pivot point of an occurrence (and its descendants if recursively) to the origin (0,0,0) |
MovePivotPointToSelectionCenter(OccurrenceList) | Move the pivot point of all given occurrences to the center of all occurrences |
MovePivotPointToTargetedOccurrenceCenter(OccurrenceList, uint, bool) | Move the pivot point of each occurrence listed in the function input, to the center of the targeted occurrence Center (and of its children if the parameter is True) |
OnAnimationAdded(Action<Params>, CancellationTokenSource) | |
OnAnimationChanged(Action<Params>, CancellationTokenSource) | |
OnAnimationCleared(Action<Params>, CancellationTokenSource) | |
OnAnimationRemoved(Action<Params>, CancellationTokenSource) | |
OnSceneChanged(Action<Params>, CancellationTokenSource) | |
OnSelectionChanged(Action<Params>, CancellationTokenSource) | |
OnVariantChanged(Action<Params>, CancellationTokenSource) | |
OnonRayProbe(Action<Params>, CancellationTokenSource) | |
OnonSphereProbe(Action<Params>, CancellationTokenSource) | |
Print(uint) | Print an occurrence tree on log |
PrototypeSubTree(uint) | Create occurrences that prototype the given occurrence and all its subtree |
Rake(uint, bool) | Set the same parent to all descending parts (all parts will be singularized) |
RayCast(Ray, uint) | |
RayCastAll(Ray, uint) | |
RemoveFilterFromLibrary(uint) | Remove a filter from the filters library |
RemoveKeyframe(uint, ulong) | Removes a keyframe in the curve |
RemoveMaterials(OccurrenceList) | Recursively remove all materials |
RemoveMetadata(uint, string) | Remove a property from a metadata |
RemoveSymmetryMatrices(uint) | Remove symmetry matrices (apply matrices on geometries on nodes under an occurrence with a symmetry matrix |
RemoveVariant(uint) | Remove a variant |
RenameLongOccurrenceName(int) | truncate names of occurrence with too long names |
ReplaceMaterial(uint, uint, OccurrenceList) | Replace a material by another everywhere it is used |
ResetPartTransform(uint) | Set all part transformation matrices to identity in a sub-tree, transformation will be applied to the shapes |
ResetTransform(uint, bool, bool, bool) | Set all transformation matrices to identity in a sub-tree. |
ResizeTextures(ResizeTexturesInputMode, ResizeTexturesResizeMode, bool) | Resizes the textures from a selection of occurrences (resizes all textures used by these occurrences), or from a selection of textures |
RewriteFilterExpression(string) | Parse the given expression, and regenerate it from the internal representation structure |
Rotate(uint, Point3, double) | Modify the local matrix of the scene node to apply a rotation |
Select(OccurrenceList) | Add occurrences to selection |
SelectAllPartOccurrences() | Select all part occurrences |
SelectByMaterial(uint) | Selects occurrences for which the property "Material" is the given material |
SelectByMaximumSize(OccurrenceList, double, double, bool) | Select all parts meeting the criteria |
SelectByVisibleMaterial(uint) | Selects parts for which the given material is visible in the viewer |
SelectDuplicated(double, double, double, double) | Select duplicated parts |
SelectInstances(uint) | Select occurrences sharing the same prototype as the given one |
SelectPartOccurrencesInBox(ExtendedBox, bool) | find part occurrences in the scene in a given box and add them to the selection |
SelectPartsFromNoShow() | Select hidden parts |
SelectVisibleParts() | Select visible parts |
SeparateSelection() | Separate all polygones form their original parts into a new one |
SetComponentOccurrence(uint, uint) | Move a component to an occurrence |
SetCurrentVariant(uint) | Change the current variant used |
SetDefaultVariant() | Set the default variant |
SetLocalMatrix(uint, Matrix4) | change the local matrix on an occurrence |
SetMultipleOccurrenceUserData(uint, OccurrenceList, PtrList) | Batch version of setOccurrenceUserData |
SetOccurrenceMaterial(uint, uint) | Set the material on a occurrence |
SetOccurrenceName(uint, string) | Returns the name of an occurrence |
SetOccurrenceUserData(uint, uint, IntPtr) | Set or replace a userdata stored on an occurrence |
SetParent(uint, uint, bool, uint, bool) | Set the parent of an occurrence |
SetPartMesh(uint, uint) | Add a mesh to a part (create a TessellatedShape on the part) |
SetPartModel(uint, uint) | Add a model to a part (create a BRepShape on the part) |
SetPartsTransforms(PartList, Matrix4List) | Set the transform matrix of each given parts |
SetPartsTransformsIndexed(PartList, IntList, Matrix4List) | Set the transform matrix of each given parts (indexed mode) |
SetPivotOnly(uint, Matrix4) | Set the pivot of an occurrence to the given transformation matrix, the geometry will not be moved (warning: do not confuse with property Transform which actually move the occurrence) |
SetPrototype(uint, uint) | Sets the prototype of an occurrence |
SetSubpartMaterial(uint, uint, uint) | Set a subpart material assignment using a SubpartMaterial component |
SetSubpartVariantMaterials(uint, VariantMaterialList) | set materials in variant |
SetSubpartVariantMaterialsList(VariantList, MaterialListList) | set all the materials list in variants |
SetVariantTree(uint, uint) | Set the alternative tree to use for this variant |
Show(uint) | Show the given occurrence |
ShowOnly(uint) | Show only the given occurrence |
SubscribeToOccurrenceUserData() | subscribe to occurrence user data. multiple different userdata can be stored on the same occurrences if subscribeToOccurrenceUserData is called multiple times |
TransferCADMaterialsOnPartOccurrences(uint) | Set all materials on part occurrences |
TransferMaterialsOnPatches(uint) | Take the first instance material and set it one the mesh patches |
TransferSubpartMaterialsOnPatches(uint) | Assign SubpartMaterialComponent materials on the occurrence's part shapes. This might affect other Part in the scene if not singularized before. |
Unisolate() | Exit the isolate mode |
UnlinkPropertyToAnimation(uint, uint, string) | Unlinks a binder |
UnloadOoC(uint) | Ask an Out of Core component to unload its sub-scene |
Unselect(OccurrenceList) | Remove occurrences to selection |
UnsetMultipleOccurrenceUserData(uint, OccurrenceList) | Batch version of unsetOccurrenceUserData |
UnsetOccurrenceUserData(uint, uint) | Unset the userdata stored on an occurrence |
UnsubscribeFromOccurrenceUserData(uint) | |
UpdateRayProber(uint, Ray) | Updates the designed ray prober |
UpdateSphereProber(uint, Point3, double) | Updates the designed sphere prober |
WaitAnimationAdded(CancellationTokenSource) | |
WaitAnimationChanged(CancellationTokenSource) | |
WaitAnimationCleared(CancellationTokenSource) | |
WaitAnimationRemoved(CancellationTokenSource) | |
WaitSceneChanged(CancellationTokenSource) | |
WaitSelectionChanged(CancellationTokenSource) | |
WaitVariantChanged(CancellationTokenSource) | |
WaitonRayProbe(CancellationTokenSource) | |
WaitonSphereProbe(CancellationTokenSource) |